diff --git a/doc/api.rst b/doc/api.rst index c0398ec3..76f8dc25 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -323,6 +323,8 @@ Utilities .. doxygenfunction:: fmt::join(It begin, Sentinel end, string_view sep) -> join_view +.. doxygenfunction:: fmt::group_digits(T value) -> group_digits_view + .. doxygenclass:: fmt::detail::buffer :members: diff --git a/include/fmt/format.h b/include/fmt/format.h index 32febe1e..425de979 100644 --- a/include/fmt/format.h +++ b/include/fmt/format.h @@ -2688,6 +2688,15 @@ template <> struct formatter { // group_digits_view is not derived from view because it copies the argument. template struct group_digits_view { T value; }; +/** + Returns a view that formats an integer value using ',' as a locale-independent + thousands separator. + + **Example**:: + + fmt::print("{}", fmt::group_digits(12345)); + // Output: "12,345" + */ template auto group_digits(T value) -> group_digits_view { return {value}; } @@ -2782,8 +2791,8 @@ struct formatter, Char> { }; /** - Returns an object that formats the iterator range `[begin, end)` with - elements separated by `sep`. + Returns a view that formats the iterator range `[begin, end)` with elements + separated by `sep`. */ template auto join(It begin, Sentinel end, string_view sep) -> join_view { @@ -2792,7 +2801,7 @@ auto join(It begin, Sentinel end, string_view sep) -> join_view { /** \rst - Returns an object that formats `range` with elements separated by `sep`. + Returns a view that formats `range` with elements separated by `sep`. **Example**::