Add documentation for compute function keyword arguments

[f0uriest]

Resolves #707

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.34%. Comparing base (59ff78b) to head (8ad9b7f).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #987   +/-   ##
=======================================
  Coverage   95.34%   95.34%           
=======================================
  Files          87       87           
  Lines       21778    21784    +6     
=======================================
+ Hits        20765    20771    +6     
  Misses       1013     1013           

Files	Coverage Δ
desc/compute/__init__.py	100.00% <100.00%> (ø)
desc/compute/_bootstrap.py	100.00% <ø> (ø)
desc/compute/_curve.py	99.42% <ø> (ø)
desc/compute/_equil.py	100.00% <ø> (ø)
desc/compute/_field.py	100.00% <ø> (ø)
desc/compute/_metric.py	100.00% <ø> (ø)
desc/compute/_omnigenity.py	100.00% <ø> (ø)
desc/compute/_surface.py	95.10% <ø> (ø)
desc/compute/data_index.py	96.07% <100.00%> (+0.52%)	⬆️
desc/compute/utils.py	96.38% <100.00%> (-0.02%)	⬇️

[github-actions]

|             benchmark_name             |         dt(%)          |         dt(s)          |        t_new(s)        |        t_old(s)        | 
| -------------------------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
 test_build_transform_fft_lowres         |     +1.95 +/- 2.25     | +3.43e-02 +/- 3.96e-02 |  1.79e+00 +/- 3.0e-02  |  1.76e+00 +/- 2.6e-02  |
 test_build_transform_fft_midres         |     +1.07 +/- 2.69     | +2.10e-02 +/- 5.28e-02 |  1.98e+00 +/- 4.9e-02  |  1.96e+00 +/- 2.0e-02  |
 test_build_transform_fft_highres        |     +0.44 +/- 1.38     | +1.03e-02 +/- 3.23e-02 |  2.36e+00 +/- 2.3e-02  |  2.35e+00 +/- 2.3e-02  |
 test_equilibrium_init_lowres            |     +0.90 +/- 1.29     | +8.55e-02 +/- 1.23e-01 |  9.63e+00 +/- 9.9e-02  |  9.54e+00 +/- 7.3e-02  |
 test_equilibrium_init_medres            |     -0.88 +/- 1.39     | -9.06e-02 +/- 1.43e-01 |  1.02e+01 +/- 1.2e-01  |  1.03e+01 +/- 8.1e-02  |
 test_equilibrium_init_highres           |     +0.43 +/- 2.05     | +5.15e-02 +/- 2.46e-01 |  1.20e+01 +/- 1.3e-01  |  1.20e+01 +/- 2.1e-01  |
 test_objective_compile_dshape_current   |     +0.02 +/- 10.01    | +6.76e-04 +/- 3.54e-01 |  3.54e+00 +/- 2.4e-01  |  3.54e+00 +/- 2.6e-01  |
 test_objective_compile_atf              |     +0.16 +/- 1.53     | +1.13e-02 +/- 1.09e-01 |  7.18e+00 +/- 8.5e-02  |  7.17e+00 +/- 6.9e-02  |
 test_objective_compute_dshape_current   |     +0.48 +/- 2.68     | +1.90e-05 +/- 1.05e-04 |  3.94e-03 +/- 8.7e-05  |  3.92e-03 +/- 5.9e-05  |
 test_objective_compute_atf              |     +5.11 +/- 2.70     | +9.15e-04 +/- 4.82e-04 |  1.88e-02 +/- 3.1e-04  |  1.79e-02 +/- 3.7e-04  |
 test_objective_jac_dshape_current       |     -0.57 +/- 5.88     | -2.39e-04 +/- 2.49e-03 |  4.21e-02 +/- 1.6e-03  |  4.23e-02 +/- 1.9e-03  |
 test_objective_jac_atf                  |     +2.62 +/- 3.61     | +4.92e-02 +/- 6.78e-02 |  1.93e+00 +/- 4.5e-02  |  1.88e+00 +/- 5.1e-02  |
 test_perturb_1                          |     -0.86 +/- 4.01     | -1.24e-01 +/- 5.81e-01 |  1.44e+01 +/- 3.7e-01  |  1.45e+01 +/- 4.5e-01  |
 test_perturb_2                          |     -0.87 +/- 2.80     | -1.68e-01 +/- 5.44e-01 |  1.92e+01 +/- 4.6e-01  |  1.94e+01 +/- 2.9e-01  |
 test_proximal_jac_atf                   |     -1.23 +/- 1.69     | -8.84e-02 +/- 1.21e-01 |  7.09e+00 +/- 1.1e-01  |  7.18e+00 +/- 4.5e-02  |
 test_proximal_freeb_compute             |     -0.77 +/- 0.93     | -9.99e-04 +/- 1.22e-03 |  1.29e-01 +/- 9.4e-04  |  1.30e-01 +/- 7.8e-04  |
 test_proximal_freeb_jac                 |     +0.21 +/- 1.00     | +1.51e-02 +/- 7.15e-02 |  7.19e+00 +/- 4.2e-02  |  7.17e+00 +/- 5.8e-02  |