Docstring cleanup and improvement of style guide compliance #119
Conversation
bwohlberg
added
documentation
Codecov Report
@@ Coverage Diff @@
## main #119 +/- ##
==========================================
+ Coverage 90.84% 90.89% +0.04%
==========================================
Files 42 42
Lines 2983 2997 +14
==========================================
+ Hits 2710 2724 +14
Misses 273 273
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
| @@ -69,43 +56,21 @@ def conjugated_grad(*args, **kwargs): | |||
| return conjugated_grad_aux if has_aux else conjugated_grad | |||
|
|
|||
|
|
|||
| # Append docstring from original jax function | |||
| grad.__doc__ = _append_jax_docs(grad) | |||
There was a problem hiding this comment.
These docs aren't rendering correctly (e.g. see the text after Args: in https://scico--119.org.readthedocs.build/en/119/_autosummary/scico.html#scico.grad). I believe I got something similar working in scico.random after a lot of fighting, see
Line 106 in 76ad408
There was a problem hiding this comment.
Strange, I thought it rendered correctly when I tried to build docs locally. But I guess I missed that. Thanks for the suggestion; I'll give it a try.
There was a problem hiding this comment.
Not so simple, unfortunately.
There was a problem hiding this comment.
Fixed in 376c06a.
|
|
||
| Returns: | ||
| tuple: A tuple (x, key) containing: | ||
|
|
||
| - **x** : (DeviceArray): Generated random array | ||
| - **x** : (DeviceArray): Generated random array. |
There was a problem hiding this comment.
Why the "**" formatting here?
There was a problem hiding this comment.
To make the variables names bold, for compatibility with the parameters section.
Docstring cleanup and improvement of style guide compliance.