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

Pave the way for per-version transition guides #2115

Merged
merged 6 commits into from
Jul 30, 2021

Conversation

jougs
Copy link
Contributor

@jougs jougs commented Jul 28, 2021

This PR removes all transition information from anywhere but the transition guides. It also moves things around, so the transition guide can now be in a directory corresponding to the name of the Git tag under release_notes.

@jougs jougs added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Jul 28, 2021
@jougs jougs added this to the NEST 3.1 milestone Jul 28, 2021
@jougs jougs self-assigned this Jul 28, 2021
@jessica-mitchell
Copy link
Contributor

thanks for this PR @jougs
I was wondering whether or not the NEST 3.0 features should be made more visible - simply because these are substantial new additions to NEST; a user who has 3.1 might need to reference the node or connection handling guides. I assume that the reference guide comparing NEST 2.x to 3.0 is also valid for 3.x. I don't think 3.0 release notes would necessarily be the first place a user would look for such information.

What do you think of moving these to the guides/ directory, remove the 3.0 specification but also link to them from the release notes section for NEST 3.0?

@jougs
Copy link
Contributor Author

jougs commented Jul 29, 2021

I totally agree that the feature information from the NEST 3.0 transition guides needs to be integrated into the existing guides and probably new ones on node management and parametrization. Contrary to what I said in our video call earlier, that integration looks not so straightforward after all. I would thus postpone that to another PR and keep the scope of this one to what it currently is.

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 if you want to keep this PR simple, I'm fine with that for now

I just noticed some broken links - can you check, I think there are other places in userdoc/ that the file name and location have not been updated for spatially_structured_networks

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! lgtm

@jougs
Copy link
Contributor Author

jougs commented Jul 30, 2021

@terhorstd: I will merge without waiting for your review, as this blocks some other work of mine. If you have additional ideas, please add a comment here.

@jougs jougs removed the request for review from terhorstd July 30, 2021 14:04
@jougs jougs merged commit b6c1e53 into nest:master Jul 30, 2021
@jougs jougs deleted the transition_guides branch August 31, 2023 14:02
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: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants