From 5092b198bc59ed25393de737187e8fa7dae43e60 Mon Sep 17 00:00:00 2001
From: Victor Zverovich <viz@fb.com>
Date: Sat, 18 Sep 2021 10:47:51 -0700
Subject: [PATCH] Document group_digits

---
 doc/api.rst          |  2 ++
 include/fmt/format.h | 15 ++++++++++++---
 2 files changed, 14 insertions(+), 3 deletions(-)

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<It, Sentinel>
 
+.. doxygenfunction:: fmt::group_digits(T value) -> group_digits_view<T>
+
 .. 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<bytes> {
 // group_digits_view is not derived from view because it copies the argument.
 template <typename T> 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 <typename T> auto group_digits(T value) -> group_digits_view<T> {
   return {value};
 }
@@ -2782,8 +2791,8 @@ struct formatter<join_view<It, Sentinel, Char>, 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 <typename It, typename Sentinel>
 auto join(It begin, Sentinel end, string_view sep) -> join_view<It, Sentinel> {
@@ -2792,7 +2801,7 @@ auto join(It begin, Sentinel end, string_view sep) -> join_view<It, Sentinel> {
 
 /**
   \rst
-  Returns an object that formats `range` with elements separated by `sep`.
+  Returns a view that formats `range` with elements separated by `sep`.
 
   **Example**::