[Docs] Includes macro information in published documentation (#716)

Author: paupino

.buildnumber

@@ -1,3 +1,3 @@
 1
 37
-0
+1

Cargo.toml

@@ -12,7 +12,7 @@ name = "rust_decimal"
 readme = "./README.md"
 repository = "https://github.com/paupino/rust-decimal"
 rust-version = "1.67.1"
-version = "1.37.0"
+version = "1.37.1"
 
 [package.metadata.docs.rs]
 all-features = true

README.md

@@ -32,6 +32,12 @@ Alternatively, you can edit your `Cargo.toml` directly and run `cargo update`:
 rust_decimal = "1.37"
 ```
 
+To enable macro support, you can enable the `macros` feature:
+
+```sh
+$ cargo add rust_decimal --features macros
+```
+
 ## Usage
 
 Decimal numbers can be created in a few distinct ways. The easiest and most efficient method of creating a Decimal is to
@@ -106,6 +112,7 @@ assert_eq!(total, dec!(27.26));
 * [borsh](#borsh)
 * [c-repr](#c-repr)
 * [legacy-ops](#legacy-ops)
+* [macros](#macros)
 * [maths](#maths)
 * [ndarray](#ndarray)
 * [rkyv](#rkyv)
@@ -162,6 +169,21 @@ As of `1.10` the algorithms used to perform basic operations have changed which
 improvements.
 To maintain backwards compatibility this can be opted out of by enabling the `legacy-ops` feature.
 
+### `macros`
+
+The `macros` feature enables a compile time macro `dec` to be available at both the crate root, and via prelude.
+
+This parses the input at compile time and converts it to an optimized `Decimal` representation. Invalid inputs will
+cause a compile time error.
+
+Any Rust number format is supported, including scientific notation and alternate bases.
+
+```rust
+use rust_decimal::prelude::*;
+
+assert_eq!(dec!(1.23), Decimal::new(123, 2));
+```
+
 ### `maths`
 
 The `maths` feature enables additional complex mathematical functions such as `pow`, `ln`, `enf`, `exp` etc.

macros/src/lib.rs

@@ -42,7 +42,9 @@ use syn::{
     parse_macro_input, Expr, Ident, LitInt, Result, Token,
 };
 
-/// Transform a literal number directly to a `Decimal` at compile time. Any Rust number format works.
+/// Transform a literal number directly to a `Decimal` at compile time.
+///
+/// Any Rust number format works, for example:
 ///
 /// - `dec!(1)`, `dec!(-1)`, `dec!(1_999)`, `dec!(- 1_999)`
 /// - `dec!(0b1)`, `dec!(-0b1_1111)`, `dec!(0o1)`, `dec!(-0o1_777)`, `dec!(0x1)`, `dec!(-0x1_Ffff)`
@@ -75,6 +77,8 @@ use syn::{
 /// assert_eq!("-5.4321", number.to_string());
 /// let number = dec!(-0o1_777);
 /// assert_eq!("-1023", number.to_string());
+/// let number = dec!(-1_777, radix 8);
+/// assert_eq!("-1023", number.to_string());
 /// ```
 ///
 #[proc_macro]