Document basis #274
Document basis #274
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #274 +/- ##
===============================================
- Coverage 97.27% 96.10% -1.17%
===============================================
Files 25 34 +9
Lines 2199 2491 +292
===============================================
+ Hits 2139 2394 +255
- Misses 60 97 +37 ☔ View full report in Codecov by Sentry. |
|
Things I noticed in #273 that should be part of this PR :
EDIT: We're going to refer to them as "categories", and generally use Eval / Conv to refer to them. |
There was a problem hiding this comment.
Some small changes that can be committed here, and then I pushed some tweaks to the wording. If you think my changes look good, then I'm good to go!
The only thing I did potentially worth discussing is that I added a bit to the top of the composite basis page trying to give a quick easy-to-understand summary of additive vs. multiplicative, so double-check that's accurate!
| path.mkdir(parents=True, exist_ok=True) | ||
|
|
||
| if path.exists(): | ||
| fig.savefig(path / "plot_01_1D_basis_function.svg") | ||
|
|
||
|
|
||
| print(path.resolve(), path.exists()) |
There was a problem hiding this comment.
is this section still necessary (with the plot_directive)? and, regardless, we probably don't need to print out the path right, that's just for internal debugging
There was a problem hiding this comment.
removed it!
| @@ -304,7 +304,7 @@ if root: | |||
| path = Path(root) / "html/_static/thumbnails/background" | |||
| # if local store in ../_build/html/... | |||
| else: | |||
| path = Path("../_build/html/_static/thumbnails/background") | |||
| path = Path("../../_build/html/_static/thumbnails/background") | |||
There was a problem hiding this comment.
same point about whether we need this anymore
There was a problem hiding this comment.
removed this too
Co-authored-by: William F. Broderick <[email protected]>
…nto document_basis
Restructured the background documentation for basis:
This PR follows #273