-
Notifications
You must be signed in to change notification settings - Fork 113
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Consolidate NMODL docs and improve their discoverability #2922
Conversation
A few more possible improvements pending discussion:
Many more things can be cleaned up about these pages, but discoverability and preventing the duplicates from diverging more would seem to be the priority. |
✔️ a6df245 -> Azure artifacts URL |
This comment has been minimized.
This comment has been minimized.
✔️ fefd2df -> Azure artifacts URL |
This comment has been minimized.
This comment has been minimized.
Briefly skimming the source, I'd say yes, POINTER should be part of the NEURON block (and
If it'd improve readability, doesn't require too many changes, and doesn't have any conflicts with existing packages, I'm all for it!
I would be in favor of keeping it, but updating the links (see this page, links at the top need to be changed), and maybe putting a giant warning sign "UNDER CONSTRUCTION/DEVELOPMENT" for now, we can remove/modify it in another PR. |
Thanks for the comments Goran! For the turorials page, people in the meeting yesterday seemed to be in favour of removing it for now and adding it back later if there's time to work it out. I'm now implementing the tabs so we can see how that looks, will push it later today. |
I agree.
I agree
I lean toward (temporary?) removal. The negative impression at the moment is pretty strong. Is it much help to a future documentation author? |
The only thing that could be potentially helpful are the example mod files, which are sorely missing from the main docs (though admittedly the examples are also very sparsely documented), and having them in the docs somewhere as a future reference could be useful (rather than having to write them from scratch or digging them out from git history). Again, I've no strong opinion on this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice improvement. Forms a good basis for bringing some details up to date.
✔️ 7706c51 -> Azure artifacts URL |
This comment has been minimized.
This comment has been minimized.
7706c51
to
3d60327
Compare
Quality Gate passedIssues Measures |
✔️ 3d60327 -> Azure artifacts URL |
Thanks Goran and Michael for the comments!
Regarding the tutorial page, I removed the small |
Duplicate versions of the NMODL documentation pages currently exist under Python and HOC:
hoc/modelspec/programmatic/mechanisms/nmodl.html
hoc/modelspec/programmatic/mechanisms/nmodl2.html
python/modelspec/programmatic/mechanisms/nmodl.html
python/modelspec/programmatic/mechanisms/nmodl2.html
Very little content in these pages is specific to either HOC or Python, and the pages have diverged, with recent additions only added to the Python versions, and some earlier corrections only added to the HOC versions.
In addition, these pages are nearly impossible to find by clicking through the documentation, even though they serve as a main source of documentation for the NMODLanguage.
This PR merges the Python/HOC versions of these pages together and moves them to the following location:
nmodl/language/nmodl.html
nmodl/language/nmodl_neuron_extension.html
The (nearly empty) page previously at this location is renamed to
nmodl/tutorials.html
.