Document namespace use.

cdfbd128 · Victor Zverovich · 64005c04 · cdfbd128
Commit cdfbd128 authored Apr 19, 2014 by Victor Zverovich
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

doc/index.rst doc/index.rst +4 -0

No files found.
--- 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