Skip to content
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

Enhance and clean up model documentation #2246

Merged
merged 9 commits into from
Jan 14, 2022
Merged

Enhance and clean up model documentation #2246

merged 9 commits into from
Jan 14, 2022

Conversation

jougs
Copy link
Contributor

@jougs jougs commented Dec 14, 2021

This PR addresses the remaining open action items and thereby fixes #1620.

@jougs jougs added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: Internal API Changes were introduced in basic internal workings of the simulator that developers need to know labels Dec 14, 2021
@jougs jougs added this to In progress in Documentation via automation Dec 14, 2021
@jougs jougs added this to To do in Models via automation Dec 14, 2021
@jougs jougs changed the title Userdocs Enhance and clean up model documentation Dec 14, 2021
@jougs
Copy link
Contributor Author

jougs commented Jan 10, 2022

@terhorstd, @jessica-mitchell: friendly ping!

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jougs looks good, I just made some suggestions to mainly adding double back ticks in a few places

models/noise_generator.h Outdated Show resolved Hide resolved
models/noise_generator.h Outdated Show resolved Hide resolved
models/noise_generator.h Outdated Show resolved Hide resolved
models/noise_generator.h Outdated Show resolved Hide resolved
models/noise_generator.h Outdated Show resolved Hide resolved
models/iaf_psc_alpha_canon.h Outdated Show resolved Hide resolved
models/iaf_psc_alpha_canon.h Outdated Show resolved Hide resolved
models/iaf_psc_alpha_canon.h Outdated Show resolved Hide resolved
models/iaf_psc_delta_ps.h Outdated Show resolved Hide resolved
models/iaf_psc_delta_ps.h Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Jan 13, 2022
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
@jougs
Copy link
Contributor Author

jougs commented Jan 13, 2022

@jessica-mitchell: I have applied most of your suggestions and have two questions for the as-of-yet unapplied ones (mostly regarding SetDefaults):

  • Instead of just making them typewriter by double-backticking them, what about marking the functions with :py:func:, so they are auto-linked to the PyNEST API?
  • Is there a similar mechanism (existing/planned) for the models? The links into the model directory are also pretty much generic after all.

@jessica-mitchell
Copy link
Contributor

* Instead of just making them typewriter by double-backticking them, what about marking the functions with `:py:func:`, so they are auto-linked to the PyNEST API?

Ah yes, that would make more sense, I just wasn't thinking about it

* Is there a similar mechanism (existing/planned) for the models? The links into the model directory are also pretty much generic after all.

Yes there is a way to do this but not implemented in any way yet;i think this could be something we look at in a future PR though

@jougs
Copy link
Contributor Author

jougs commented Jan 13, 2022

@jessica-mitchell: I've addressed all remaining issues as you suggested. You get to decide if you actually find the second review necessary for this one, or if your approval would be sufficient to merge.

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jougs thanks! looks good to me and considering these are basically formatting issues, I'd say one review is enough

@jougs jougs merged commit 9928609 into nest:master Jan 14, 2022
Documentation automation moved this from Review to Done Jan 14, 2022
@clinssen clinssen moved this from To do to Done in Models Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: Internal API Changes were introduced in basic internal workings of the simulator that developers need to know S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Models
  
Done
Development

Successfully merging this pull request may close these issues.

Model documentation enhancement checklist
2 participants