From 00f3d16b128b1b866c8fd6555a2d753c1186d622 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Sat, 10 Apr 2021 08:07:16 -0700 Subject: [PATCH] Update docs --- doc/api.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index ac85222c..2e1bce3f 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -29,8 +29,8 @@ Core API ======== ``fmt/core.h`` defines the core API which provides argument handling facilities -and a lightweight subset of formatting functions. In the header-only mode -include ``fmt/format.h`` instead of ``fmt/core.h``. +and a lightweight subset of formatting functions. It is only beneficial when +using {fmt} as a library and not in the header-only mode. The following functions use :ref:`format string syntax ` similar to that of Python's `str.format