Electrical Component Docstrings #41
Conversation
|
Can you also add the new docstrings to https://github.com/SciML/ModelingToolkitStandardLibrary.jl/blob/main/docs/src/API/electrical.md ? |
Codecov Report
@@ Coverage Diff @@
## main #41 +/- ##
=======================================
Coverage 69.03% 69.03%
=======================================
Files 23 23
Lines 956 956
=======================================
Hits 660 660
Misses 296 296
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
|
|
||
| # States | ||
| - `v(t)`: [`V`] | ||
| The voltage across the capacitor, given by `D(v) ~ p.i / C` |
There was a problem hiding this comment.
The states are actually inherited from the OnePort component, hence they are v and i. Maybe a @ref would do it.
The Digital stuff isn't tested and the include is commended out, so the doc build will fail I think. |
|
Documenter doesn't fail when docstrings aren't defined, it throws a warning and renders an error message in the docs, which appears to be what's happening here judging by the CI logs. |
|
IMO, let's merge this and let it throw a warning in the docs for now. It will leave clear markers of what needs to be finished still, but let people know it's coming soon. |
Copied over from #7 without the git issues.