Skip to content

Commit 556facc

Browse files
committed
Minor macro docs fixes
1 parent b58a848 commit 556facc

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

core/src/macros/mod.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,8 +1519,9 @@ pub(crate) mod builtin {
15191519
($file:expr $(,)?) => {{ /* compiler built-in */ }};
15201520
}
15211521

1522-
/// the derivative of a given function in the forward mode of differentiation.
1523-
/// It may only be applied to a function.
1522+
/// This macro uses forward-mode automatic differentiation to generate a new function.
1523+
/// It may only be applied to a function. The new function will compute the derivative
1524+
/// of the function to which the macro was applied.
15241525
///
15251526
/// The expected usage syntax is:
15261527
/// `#[autodiff_forward(NAME, INPUT_ACTIVITIES, OUTPUT_ACTIVITY)]`
@@ -1537,9 +1538,9 @@ pub(crate) mod builtin {
15371538
/* compiler built-in */
15381539
}
15391540

1540-
/// Automatic Differentiation macro which allows generating a new function to compute
1541-
/// the derivative of a given function in the reverse mode of differentiation.
1542-
/// It may only be applied to a function.
1541+
/// This macro uses reverse-mode automatic differentiation to generate a new function.
1542+
/// It may only be applied to a function. The new function will compute the derivative
1543+
/// of the function to which the macro was applied.
15431544
///
15441545
/// The expected usage syntax is:
15451546
/// `#[autodiff_reverse(NAME, INPUT_ACTIVITIES, OUTPUT_ACTIVITY)]`

0 commit comments

Comments
 (0)