NMODL Documentation Improvement#2011
Conversation
iomaganaris
commented
Oct 6, 2022
- Added documentation in various constructs in hoc and python documentation. Also added TODOs to missing ones
- This PR is also related to NMODLanguage documentation improvements and addition of tests and examples #1996 where there are tests and examples added to some of the constructs mentioned in the documentation
…tion. Also added TODOs to missing ones
Codecov Report
@@ Coverage Diff @@
## master #2011 +/- ##
=======================================
Coverage 47.51% 47.51%
=======================================
Files 528 528
Lines 118804 118804
=======================================
Hits 56444 56444
Misses 62360 62360 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
✔️ 3f92398 -> Azure artifacts URL |
|
Are the docs built when one builds nrn with |
|
✔️ bd1497b -> Azure artifacts URL |
Hello Michael, Yes, this PR includes only the documentation that can be found in the docs built with In some of the NMODL keywords you can see that there are also |
|
@iomaganaris do you want to activate RTD builds for this branch? |
|
Sneak peek : https://nrn.readthedocs.io/en/magkanar-nmodl_docs/ |
The updated docs are in https://nrn.readthedocs.io/en/magkanar-nmodl_docs/python/modelspec/programmatic/mechanisms/nmodl.html, https://nrn.readthedocs.io/en/magkanar-nmodl_docs/python/modelspec/programmatic/mechanisms/nmodl2.html and their corresponding HOC docs |
nrnhines
left a comment
There was a problem hiding this comment.
I'm happy with the structure. Not for this PR but it would be nice if there were a way to combine identical hoc and python versions.
…tion. Also added TODOs to missing ones (#2011) Co-authored-by: Pramod Kumbhar <pramod.s.kumbhar@gmail.com>
…tion. Also added TODOs to missing ones (#2011) Co-authored-by: Pramod Kumbhar <pramod.s.kumbhar@gmail.com>
…tion. Also added TODOs to missing ones (#2011) Co-authored-by: Pramod Kumbhar <pramod.s.kumbhar@gmail.com>