From 8d4f3e91b2e522be7ca817c36d758943e14393a7 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Sun, 6 Mar 2022 10:12:40 -0800 Subject: [PATCH] Update docs --- doc/api.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 6f66a100..6ace3486 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -450,16 +450,19 @@ The format syntax is described in :ref:`chrono-specs`. Format string compilation ========================= -``fmt/compile.h`` provides format string compilation support when using -``FMT_COMPILE``. Format strings are parsed, checked and converted into efficient -formatting code at compile-time. This supports arguments of built-in and string -types as well as user-defined types with ``constexpr`` ``parse`` functions in -their ``formatter`` specializations. Format string compilation can generate more -binary code compared to the default API and is only recommended in places where -formatting is a performance bottleneck. +``fmt/compile.h`` provides format string compilation enabled via the +``FMT_COMPILE`` macro or the ``_cf`` user-defined literal. Format strings +marked with ``FMT_COMPILE`` or ``_cf`` are parsed, checked and converted into +efficient formatting code at compile-time. This supports arguments of built-in +and string types as well as user-defined types with ``constexpr`` ``parse`` +functions in their ``formatter`` specializations. Format string compilation can +generate more binary code compared to the default API and is only recommended in +places where formatting is a performance bottleneck. .. doxygendefine:: FMT_COMPILE +.. doxygenfunction:: operator""_cf() + .. _color-api: Terminal color and text style