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

Collect all information on changes in "what's new" #2463

Merged
merged 6 commits into from
Sep 8, 2022

Conversation

heplesser
Copy link
Contributor

This PR collects information on changes in NEST 3.4 in the "what's new" section and removes the "release_notes" directory.

It also restructures the "What's new" file to make changes that modify NEST behavior more visible and separate information only relevant for NEST developers from information relevant for users.

Since calibrate()/pre_run_hook() are C++ methods, they are no longer labeled as py:func:.

@heplesser heplesser added T: Bug Wrong statements in the code or documentation S: High Should be handled next I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Sep 7, 2022
@heplesser heplesser added this to the NEST 3.4 milestone Sep 7, 2022
@heplesser heplesser added this to In progress in Documentation via automation Sep 7, 2022
@jessica-mitchell
Copy link
Contributor

Should the section on pre_run_hook / calibrate be removed entirely if its developer focused? I think the release notes provided on GitHub should suffice for developers. What do you think?

@heplesser
Copy link
Contributor Author

Should the section on pre_run_hook / calibrate be removed entirely if its developer focused? I think the release notes provided on GitHub should suffice for developers. What do you think?

Done with 56fec6d.

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.

@heplesser I spotted a couple of minor typos, but otherwise looks good.

doc/htmldoc/whats_new/v3.4/index.rst Outdated Show resolved Hide resolved
doc/htmldoc/whats_new/v3.4/index.rst Outdated Show resolved Hide resolved
doc/htmldoc/whats_new/v3.4/index.rst Outdated Show resolved Hide resolved
heplesser and others added 3 commits September 8, 2022 07:48
Fix typo.

Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
doc/htmldoc/whats_new/v3.4/index.rst Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Sep 8, 2022
Copy link
Contributor

@hakonsbm hakonsbm left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good now.

@heplesser heplesser merged commit 5e8790c into nest:master Sep 8, 2022
Documentation automation moved this from Review to Done Sep 8, 2022
@heplesser heplesser deleted the remove-release-notes branch October 4, 2022 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: High Should be handled next T: Bug Wrong statements in the code or documentation
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants