Fixup fmt documentation

9999years · Feb 8, 2024 · 18e8f4f · 18e8f4f
1 parent 89001e1
commit 18e8f4f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/libutil/fmt.hh b/src/libutil/fmt.hh
@@ -15,7 +15,7 @@ namespace {
  * These are equivalent:
  *
  *     formatHelper(formatter, a_0, ..., a_n)
- *     formatter % a_0 % ... % ... a_n
+ *     formatter % a_0 % ... % a_n
  *
  * With a single argument, `formatHelper(s)` is a no-op.
  */
@@ -34,10 +34,10 @@ inline void formatHelper(F & f, const T & x, const Args & ... args)
 /**
  * A helper for writing a `boost::format` expression to a string.
  *
- * These are equivalent:
+ * These are (roughly) equivalent:
  *
- *     formatHelper(formatter, a_0, ..., a_n)
- *     formatter % a_0 % ... % ... a_n
+ *     fmt(formatString, a_0, ..., a_n)
+ *     (boost::format(formatString) % a_0 % ... % a_n).str()
  *
  * However, when called with a single argument, the string is returned
  * unchanged.