Skip to content

docs: declare the brainpy / brainpy.state relationship#92

Merged
chaoming0625 merged 1 commit into
mainfrom
worktree-brainpy-relationship-docs
Jul 22, 2026
Merged

docs: declare the brainpy / brainpy.state relationship#92
chaoming0625 merged 1 commit into
mainfrom
worktree-brainpy-relationship-docs

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • New docs/project/relationship.rst: an additive (non-deprecation) declaration of how classic brainpy and the state-based brainpy.state layer relate, modeled on Numba's CUDA status notice.
  • docs/index.rst: short titled admonition on the landing page + project/relationship added to the Project toctree.

Validation

  • sphinx -b dummy (notebook execution off): exit 0, 0 warnings; relationship.html builds 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:

  • Add a dedicated documentation page describing how classic brainpy and brainpy.state relate and are intended to be used together.
  • Update the docs index to highlight and link to the new relationship page from the project section.

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.
@sourcery-ai

sourcery-ai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds 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

Change Details Files
Introduce a dedicated documentation page describing the relationship between classic brainpy and brainpy.state.
  • Create new reStructuredText document outlining the status and intended use of classic brainpy vs brainpy.state.
  • Model the relationship and status notice on Numba’s CUDA status-style explanation, including guidance and forward-looking notes.
  • Include explicit, non-deprecating language to clarify that classic brainpy remains supported while positioning brainpy.state as the state-based layer.
docs/project/relationship.rst
Expose the new relationship documentation page in the main docs index and project navigation.
  • Add a short, titled admonition to the docs landing page pointing readers to the relationship documentation.
  • Insert the new relationship page into the Project toctree so it appears in navigation and is reachable via :doc: references.
  • Ensure Sphinx builds cleanly with the new page and links (dummy builder, no notebooks) with zero warnings.
docs/index.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions

Copy link
Copy Markdown

🎉 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:

  • ✅ Your code follows our style guidelines
  • ✅ All tests pass
  • ✅ Documentation is updated (if applicable)
  • ✅ You've filled out the PR template completely

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 22, 2026
@chaoming0625
chaoming0625 merged commit 65ddd75 into main Jul 22, 2026
6 of 7 checks passed
@chaoming0625
chaoming0625 deleted the worktree-brainpy-relationship-docs branch July 22, 2026 10:02

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant