Docstring Formatting

[willtebbutt]

While working on GPU rules, I noticed there are still a few unnecessary @doc macro calls in front of docstrings. These cause weird formatting behaviour, so they're worth getting rid of to improve codebase hygiene.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines	Coverage Δ
src/fwds_rvs_data.jl	86.01% <ø> (-10.65%)	⬇️
src/test_utils.jl	67.24% <ø> (-25.87%)	⬇️
src/tools_for_rules.jl	95.78% <ø> (-3.16%)	⬇️

... and 24 files with indirect coverage changes

[github-actions]

Performance Ratio:
Ratio of time to compute gradient and time to compute function.
Warning: results are very approximate! See here for more context.

┌────────────────────────────┬──────────┬─────────┬─────────────┬─────────┐
│                      Label │ Mooncake │  Zygote │ ReverseDiff │  Enzyme │
│                     String │   String │  String │      String │  String │
├────────────────────────────┼──────────┼─────────┼─────────────┼─────────┤
│                   sum_1000 │     82.6 │     1.0 │        5.61 │    8.21 │
│                  _sum_1000 │     6.64 │  1300.0 │        34.3 │    1.07 │
│               sum_sin_1000 │     2.27 │    1.69 │        10.6 │    1.98 │
│              _sum_sin_1000 │     2.77 │   264.0 │        13.4 │    2.44 │
│                   kron_sum │     64.2 │    3.45 │       240.0 │    7.81 │
│              kron_view_sum │     59.7 │    9.57 │       231.0 │    94.8 │
│      naive_map_sin_cos_exp │     2.51 │ missing │        7.44 │    2.33 │
│            map_sin_cos_exp │     2.75 │    1.49 │        6.14 │    2.89 │
│      broadcast_sin_cos_exp │     2.62 │    3.04 │        1.46 │    2.26 │
│                 simple_mlp │     4.92 │    3.08 │        6.96 │     3.4 │
│                     gp_lml │     4.54 │    2.78 │     missing │    2.46 │
│ turing_broadcast_benchmark │     3.27 │ missing │        24.8 │ missing │
│         large_single_block │     4.42 │  4430.0 │        30.3 │    2.18 │
└────────────────────────────┴──────────┴─────────┴─────────────┴─────────┘