diff --git a/doc/api.rst b/doc/api.rst index dad51f33..46231aa2 100644 --- 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 ` similar to that of Python's `str.format