Docs improvements #430
Docs improvements #430
Conversation
Codecov Report
@@ Coverage Diff @@
## main #430 +/- ##
==========================================
- Coverage 94.86% 94.63% -0.23%
==========================================
Files 86 86
Lines 5426 5471 +45
==========================================
+ Hits 5147 5177 +30
- Misses 279 294 +15
Flags with carried forward coverage won't be shown. Click here to find out more.
|
docs/source/include/operator.rst
Outdated
| @@ -111,17 +110,17 @@ Using A LinearOperator | |||
| We implement two ways to evaluate a :class:`.LinearOperator`. The first is using standard | |||
| callable syntax: ``A(x)``. The second mimics the NumPy matrix multiplication | |||
| syntax: ``A @ x``. Both methods perform shape and type checks to validate the | |||
| input before ultimately either calling `A._eval` or generating a new :class:`.LinearOperator`. | |||
| input before ultimately either calling :code:`A._eval` or generating a new :class:`.LinearOperator`. | |||
There was a problem hiding this comment.
consider adding a note about ":code:" to https://scico.readthedocs.io/en/stable/style.html#markup
There was a problem hiding this comment.
These changes have been reverted since it became clear that they create some severe markup consistency issues.
docs/source/include/optimizer.rst
Outdated
|
|
||
|
|
||
| Subproblem Solvers | ||
| ^^^^^^^^^^^^^^^^^^ | ||
| Sub-Problem Solvers |
There was a problem hiding this comment.
Chicago manual of style disagrees, https://www.chicagomanualofstyle.org/book/ed17/part2/ch07/psec089.html Section 4.
Various docs fixes and improvements.