Clarify use of the core API in header-only mode (#1296)

fe642d76 · Victor Zverovich · a128b5b2 · fe642d76
Commit fe642d76 authored Sep 02, 2019 by Victor Zverovich
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 1 deletion

doc/api.rst doc/api.rst +2 -1

No files found.
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -23,7 +23,8 @@ Core API
 ========

 ``fmt/core.h`` defines the core API which provides argument handling facilities
-and a lightweight subset of formatting functions.
+and a lightweight subset of formatting functions. In the header-only mode
+include ``fmt/format.h`` instead of ``fmt/core.h``.

 The following functions use :ref:`format string syntax <syntax>`
 similar to that of Python's `str.format