diff --git a/doc/index.rst b/doc/index.rst index e230cc3f..18bf1c4f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,6 +5,10 @@ C++ Format Library API ---------------------- +All functions and classes provided by the C++ Format library reside +in namespace ``fmt`` and macros have prefix ``FMT_``. For brevity the +namespace is often omitted in examples. + .. doxygenfunction:: fmt::Format(StringRef) .. doxygenclass:: fmt::BasicWriter