Merge pull request #1226 from cppalliance/docs

mborland · web-flow · commit 6e1b6f806b68 · 2025-11-07T14:59:25.000+01:00
Fix formatting, wording, and typos in docs
diff --git a/doc/modules/ROOT/nav.adoc b/doc/modules/ROOT/nav.adoc
@@ -35,8 +35,6 @@
 * xref:cstdlib.adoc[]
 * xref:charconv.adoc[]
 * xref:format.adoc[]
-** xref:format.adoc#std_format[`<format>`]
-** xref:format.adoc#fmt_format[`<fmt/format.h>`]
 * xref:cfenv.adoc[]
 * xref:cfloat.adoc[]
 * xref:cstdio.adoc[]
diff --git a/doc/modules/ROOT/pages/basics.adoc b/doc/modules/ROOT/pages/basics.adoc
@@ -71,7 +71,7 @@ NOTE: Due to the differences in decimal and binary floating point numbers there
 
 == Fundamental Operations
 
-The fundamental operations of numerical type (e.g. `>`, `==`, `+`, etc.) are overloaded.
+The fundamental operations of numerical types (e.g. `>`, `==`, `+`, etc.) are overloaded.
 
 [source, c++]
 ----
@@ -96,6 +96,12 @@ int main()
 }
 ----
 
+== Rounding
+
+The default rounding mode for all operations is so-called "banker's rounding", which is to nearest (with ties to even).
+Similar to the standard library, the active rounding mode can be changed through floating point environment variables.
+For more information see: xref:cfenv.adoc[]
+
 == Using the Library
 
 The entire library can be accessed using the convenience header `<boost/decimal.hpp>`.
diff --git a/doc/modules/ROOT/pages/cfenv.adoc b/doc/modules/ROOT/pages/cfenv.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cfenv]
-= `<cfenv>` support
+= `<cfenv>` Support
 :idprefix: cfenv_
 
 WARNING: This is an expert feature.
diff --git a/doc/modules/ROOT/pages/cfloat.adoc b/doc/modules/ROOT/pages/cfloat.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cfloat]
-= `<cfloat>` support
+= `<cfloat>` Support
 :idprefix: cfloat_
 
 Macros analogous to those from https://en.cppreference.com/w/cpp/header/cfloat.html[`<cfloat>`] are provided by the library.
diff --git a/doc/modules/ROOT/pages/charconv.adoc b/doc/modules/ROOT/pages/charconv.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#charconv]
-= `<charconv>` support
+= `<charconv>` Support
 :idprefix: charconv_
 
 == <charconv>
diff --git a/doc/modules/ROOT/pages/cmath.adoc b/doc/modules/ROOT/pages/cmath.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cmath]
-= `<cmath>` support
+= `<cmath>` Support
 :idprefix: cmath_
 
 Decimal contains overloads for all functions from `<cmath>`, and they have the same handling as built-in floating point types.
diff --git a/doc/modules/ROOT/pages/cstdio.adoc b/doc/modules/ROOT/pages/cstdio.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cstdio]
-= `<cstdio>` support
+= `<cstdio>` Support
 :idprefix: cstdio_
 
 The following functions analogous to those from `<cstdio>` are provided:
diff --git a/doc/modules/ROOT/pages/cstdlib.adoc b/doc/modules/ROOT/pages/cstdlib.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cstdlib]
-= `<cstdlib>` support
+= `<cstdlib>` Support
 :idprefix: cstdlib_
 
 The following functions analogous to those from https://en.cppreference.com/w/cpp/string/byte/strtof.html[`<cstdlib>`] are provided:
diff --git a/doc/modules/ROOT/pages/decimal128_t.adoc b/doc/modules/ROOT/pages/decimal128_t.adoc
@@ -23,7 +23,7 @@ https://www.boost.org/LICENSE_1_0.txt
 |===
 
 IMPORTANT: Prior to v5.0.0 this type was known as `decimal32`.
-This support has been removed in v6.0.0.
+This name has been removed in v6.0.0.
 
 The encoding of decimal128_t is in the `xref:conversions.adoc[BID format]`.
 
diff --git a/doc/modules/ROOT/pages/decimal32_t.adoc b/doc/modules/ROOT/pages/decimal32_t.adoc
@@ -23,7 +23,7 @@ https://www.boost.org/LICENSE_1_0.txt
 |===
 
 IMPORTANT: Prior to v5.0.0 this type was known as `decimal32`.
-This support has been removed in v6.0.0.
+This name has been removed in v6.0.0.
 
 The encoding of decimal32_t is in the `xref:conversions.adoc[BID format]`.
 
diff --git a/doc/modules/ROOT/pages/decimal64_t.adoc b/doc/modules/ROOT/pages/decimal64_t.adoc
@@ -23,7 +23,7 @@ https://www.boost.org/LICENSE_1_0.txt
 |===
 
 IMPORTANT: Prior to v5.0.0 this type was known as `decimal64`.
-This support has been removed in v6.0.0.
+This name has been removed in v6.0.0.
 
 The encoding of decimal64_t is in the `xref:conversions.adoc[BID format]`.
 
diff --git a/doc/modules/ROOT/pages/decimal_fast128_t.adoc b/doc/modules/ROOT/pages/decimal_fast128_t.adoc
@@ -27,7 +27,7 @@ As is often the case this trades space for time by having greater storage width
 IMPORTANT: `decimal_fast128_t` does not support subnormal values
 
 IMPORTANT: Prior to v5.0.0 this type was known as `decimal128_fast`.
-This support has been removed in v6.0.0.
+This name has been removed in v6.0.0.
 
 [source, c++]
 ----
diff --git a/doc/modules/ROOT/pages/decimal_fast32_t.adoc b/doc/modules/ROOT/pages/decimal_fast32_t.adoc
@@ -27,7 +27,7 @@ As is often the case this trades space for time by having greater storage width
 IMPORTANT: `decimal_fast32_t` does not support subnormal values
 
 IMPORTANT: Prior to v5.0.0 this type was known as `decimal32_fast`.
-This support has been removed in v6.0.0.
+This name has been removed in v6.0.0.
 
 [source, c++]
 ----
diff --git a/doc/modules/ROOT/pages/decimal_fast64_t.adoc b/doc/modules/ROOT/pages/decimal_fast64_t.adoc
@@ -27,7 +27,7 @@ As is often the case this trades space for time by having greater storage width
 IMPORTANT: `decimal_fast64_t` does not support subnormal values
 
 IMPORTANT: Prior to v5.0.0 this type was known as `decimal64_fast`.
-This support has been removed in v6.0.0.
+This name has been removed in v6.0.0.
 
 [source, c++]
 ----
diff --git a/doc/modules/ROOT/pages/examples.adoc b/doc/modules/ROOT/pages/examples.adoc
@@ -156,7 +156,7 @@ template <typename T>
 bool float_equal(T lhs, T rhs)
 {
     using std::fabs;
-    return fabs(lhs - rhs) < std::numeric_limits<T>::epsilon(); // numeric_limits is overloaded for all decimal types
+    return fabs(lhs - rhs) < std::numeric_limits<T>::epsilon(); // numeric_limits is specialized for all decimal types
 }
 
 
@@ -182,7 +182,7 @@ int main()
 === Simple Moving Average
 
 In the examples folder there is a file named `moving_average.cpp`.
-This example shows how to parse historical stock data from file and use it.
+This example shows how to parse historical stock data from a file and use it.
 This serves as a framework for other calculations for securities.
 
 === Currency Conversion
diff --git a/doc/modules/ROOT/pages/format.adoc b/doc/modules/ROOT/pages/format.adoc
@@ -5,17 +5,14 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#format]
-= Formating support
+= Formatting Support
 :idprefix: format_
 
 Boost.Decimal supports formatting with both `<format>` (when C++20 and header are both available), and `<fmt/format.h>` with all language standards.
 
-[#std_format]
-== `<format>`
-
 Format is supported when using C++20 and a compiler with appropriate support: GCC >= 13, Clang >= 18, MSVC >= 19.40
 
-=== Locale Modifier
+== Locale Modifier
 
 If a format string begins with "L" the current global locale will be applied.
 This can be set as so:
@@ -28,7 +25,7 @@ const std::locale a(locale);
 std::locale::global(a);
 ----
 
-=== Sign Modifier
+== Sign Modifier
 
 |===
 | Modifier | Format
@@ -38,7 +35,7 @@ std::locale::global(a);
 Negative have a minus sign
 |===
 
-=== Type Modifiers
+== Type Modifiers
 
 The following type modifiers are the same as those used by built-in floating point values:
 
@@ -55,12 +52,12 @@ Example usage for scientific format would be: `{:e}`
 
 NOTE: The uppercase format will return with all applicable values in uppercase (e.g. 3.14E+02 vs 3.14e+02)
 
-=== Precision Modifiers
+== Precision Modifiers
 
 Precision can be specified in the same way as built-in floating point values.
 For example a scientific format with 3 digits or precision would be: `{:.3e}`
 
-=== Padding Modifiers
+== Padding Modifiers
 
 If you want all values to be printed with a fixed width padding is allowed before the precision modifier.
 For example with `{:10.3e}`:
@@ -70,7 +67,7 @@ For example with `{:10.3e}`:
 
 Note the space at the front of these string to keep with width at 10 characters
 
-=== String Literal Support
+== String Literal Support
 
 If you want the result to be a different string width than `char` you can specify this with the format string.
 For example if you want the result to be `wchar_t` you can use `L"{}"`.
@@ -79,13 +76,13 @@ For example if you want the result to be `wchar_t` you can use `L"{}"`.
 
 IMPORTANT: `std::format` only supports `char` and `wchar_t` types per the pass:[C++] specification.
 
-=== Putting it All Together
+== Putting it All Together
 
 The appropriate order for the full format specifier is:
 
 String literal pass:["{Sign, Padding, Precision, Type, Locale}"]
 
-=== Examples
+== Examples
 
 This example can be found in the examples/ folder as https://github.com/cppalliance/decimal/blob/develop/examples/fmt_format.cpp[fmt_format.cpp]
 
diff --git a/doc/modules/ROOT/pages/functional.adoc b/doc/modules/ROOT/pages/functional.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#functional]
-= `<functional>` support
+= `<functional>` Support
 :idprefix: functional_
 
 The following functions from https://en.cppreference.com/w/cpp/utility/hash.html[`<functional>`] are overloaded:
diff --git a/doc/modules/ROOT/pages/limits.adoc b/doc/modules/ROOT/pages/limits.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#limits]
-= `<limits>` support
+= `<limits>` Support
 :idprefix: limits_
 
 The following from `<limits>` are overloaded for each type with associated values for reference:
diff --git a/doc/modules/ROOT/pages/strings.adoc b/doc/modules/ROOT/pages/strings.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#strings]
-= `<string>` support
+= `<string>` Support
 :idprefix: string_
 
 == Construction from `std::string` and `std::string_view`
