docs: declare the brainpy / brainpy.state relationship#92
Merged
Conversation
Add an additive (non-deprecation) declaration of how classic brainpy and the state-based brainpy.state layer relate, modeled on Numba's CUDA status notice: a dedicated docs/project/relationship.rst page plus a short admonition on the landing page linking to it.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds documentation clarifying how the classic brainpy API relates to the newer state-based brainpy.state layer, and surfaces this relationship on the docs landing page and in the project navigation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
🎉 Congratulations on opening your first pull request in brainpy.state! Thank you for your contribution! A maintainer will review your changes soon. Please make sure:
We appreciate your effort in making brainpy.state better. If you have any questions, feel free to ask in the comments. Welcome to the brainpy.state community! 🌟 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/project/relationship.rst: an additive (non-deprecation) declaration of how classicbrainpyand the state-basedbrainpy.statelayer relate, modeled on Numba's CUDA status notice.docs/index.rst: short titled admonition on the landing page +project/relationshipadded to the Project toctree.Validation
sphinx -b dummy(notebook execution off): exit 0, 0 warnings;relationship.htmlbuilds and:doc:links resolve.🤖 Generated with Claude Code
Summary by Sourcery
Document the relationship between classic brainpy and the state-based brainpy.state layer and surface this explanation in the main docs landing page.
Documentation: