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.

Sign up for GitHub

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

Jump to bottom

Add note that nest.help('model_name') only works if the documentation is built #2557

Merged
merged 6 commits into from
Dec 9, 2022
Merged

Add note that nest.help('model_name') only works if the documentation is built #2557

merged 6 commits into from
Dec 9, 2022

Conversation

steffengraber
Copy link
Contributor

@steffengraber steffengraber commented Dec 1, 2022 •
edited

Fixes #2483.
The problem that no documentation is created in the conda package still exists. However, the user receives a short note about this.

@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Dec 5, 2022
@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Dec 5, 2022
@jessica-mitchell jessica-mitchell changed the title Add information that nest.help('model_name') does only works if the documentation is built Add note that nest.help('model_name') only works if the documentation is built Dec 5, 2022
@steffengraber steffengraber mentioned this pull request Dec 6, 2022
Closed
@steffengraber
Copy link
Contributor Author

After discussions in the NEST Developer and NEST Documentation meeting it was decided to remove the reference to nest.help('model_name') and instead refer to the online documentation.

jessica-mitchell
jessica-mitchell requested changes Dec 8, 2022
View reviewed changes
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.

I think we should provide link directly to model directory

doc/htmldoc/getting_help.rst Outdated Show resolved Hide resolved
pynest/nest/__init__.py Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Dec 8, 2022
steffengraber and others added 2 commits December 8, 2022 14:41
@steffengraber @jessica-mitchell
Update doc/htmldoc/getting_help.rst
3beaad1 
Add direct link to model documentation

Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
@steffengraber @jessica-mitchell
Update pynest/nest/__init__.py
6757168 
Add direct link to model documentation

Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
jessica-mitchell
jessica-mitchell approved these changes Dec 9, 2022
View reviewed changes
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.

thanks!

@jessica-mitchell
Copy link
Contributor

Merging with 1 reviewer because documentation PR

@jessica-mitchell jessica-mitchell merged commit 63caf99 into nest:master Dec 9, 2022
Documentation automation moved this from Review to Done Dec 9, 2022
@terhorstd terhorstd changed the title Add note that nest.help('model_name') only works if the documentation is built Add note that nest.help('model_name') only works if the documentation is built Jan 18, 2023
@terhorstd terhorstd added the T: Maintenance Work to keep up the quality of the code and documentation. label Jan 18, 2023
@steffengraber steffengraber deleted the fix-2483 branch September 6, 2023 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jessica-mitchell jessica-mitchell jessica-mitchell approved these changes

Assignees
No one assigned
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

No nest.help() when installed through Conda
3 participants
@steffengraber @jessica-mitchell @terhorstd