Skip to content

docs(brainpy-state): remove unrouted event-driven operators stub - #9

Merged
chaoming0625 merged 1 commit into
mainfrom
fix/remove-unrouted-event-operators-stub
Jul 29, 2026
Merged

docs(brainpy-state): remove unrouted event-driven operators stub#9
chaoming0625 merged 1 commit into
mainfrom
fix/remove-unrouted-event-operators-stub

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #7, which flagged this as a pre-existing issue.

What was wrong

skills/brainpy-state/references/brainstate-dynamics/brain-dynamics-event-driven-operators.md was draft scaffolding that shipped. Its body is ## Should eventually cover, ## Common mistakes to document, and ## Placeholder examples — a planning blueprint, not a reference, so it fails rule 21.

Three further problems, found while investigating:

  1. Nothing routed to it. I resolved every shipped file under skills/brainpy-state/ against every routing mention in SKILL.md and all references. This file was the only one absent from every routing row — a rule 20 violation.
  2. Its own links were dead. The ## Used by block named references/brainstate-dynamics/dynamics-and-integration.md and references/brainstate-dynamics/brain-dynamics-snn-workflows.md. Neither has existed in any commit in this repository (git log --all --diff-filter=A finds no addition of either).
  3. It blurred a skill boundary. Its subject — EventLinear, EventFixedProb, FixedNumConn, EventFixedNumConn — is owned by skills/brainevent/, which SKILL.md:207 already routes to for "sparse event representations, connectivity formats, event operators". Rule 5 requires those territories stay disjoint.

Why deleting is the right fix

plan.md:723 places this reference under skills/brainstate/, not skills/brainpy-state/. It was misfiled in the original draft, which explains why no brainpy-state routing row ever pointed at it. That planned brainstate reference is untouched by this PR and remains unbuilt.

The alternative — writing the reference properly — would duplicate skills/brainevent/ and require verifying API surface that the brainevent skill already documents.

What stays

The sibling brain-dynamics-delay-protocol.md is a finished, rule-21-conforming reference, routed from references/projection-patterns.md:134. It and scripts/training-snn.py are unaffected.

Verification

$ for d in skills/*/; do python -c 'from skills_ref.cli import main; main()' validate "${d%/}"; done
Valid skill: skills/brainevent
Valid skill: skills/brainpy-state
Valid skill: skills/brainstate
Valid skill: skills/brainunit
Valid skill: skills/brainx-general-guard
Valid skill: skills/brainx-install

$ node --test .github/scripts/*.test.mjs
tests 24   pass 24   fail 0

Re-audited after the deletion: no unrouted shipped files remain under skills/brainpy-state/, and no routing target is dangling. The only unresolved backticked filenames left are upstream NEST/BrainPy example names quoted inside script docstrings (hh_coba.py, pynest/examples/synapsecollection.py, and similar), which are prose, not routing links.

Summary by Sourcery

Documentation:

  • Delete placeholder brain-dynamics event-driven operators reference that was never routed and overlaps with brainevent documentation.

references/brainstate-dynamics/brain-dynamics-event-driven-operators.md was
draft scaffolding that shipped: its body is "Should eventually cover",
"Common mistakes to document", and "Placeholder examples" rather than a
reference, so it fails rule 21.

Nothing routed to it. An audit of every shipped file under skills/brainpy-state
found it to be the only one absent from every routing row, failing rule 20. Its
own "Used by" block pointed at references/brainstate-dynamics/
dynamics-and-integration.md and brain-dynamics-snn-workflows.md, neither of
which has existed in any commit in this repository.

Its subject is already owned by skills/brainevent/, which SKILL.md routes to for
sparse event representations, connectivity formats, and event operators, so
keeping a second stub here also blurred the rule 5 boundary. plan.md places this
reference under skills/brainstate/, not skills/brainpy-state/, which is why no
brainpy-state routing row ever pointed at it; that planned brainstate reference
is untouched and remains unbuilt.

The finished sibling brain-dynamics-delay-protocol.md and scripts/training-snn.py
stay; both are routed and unaffected.
@sourcery-ai

sourcery-ai Bot commented Jul 29, 2026

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

Reviewer's Guide

This PR deletes an unrouted, draft-only reference page for event-driven operators that was misfiled under brainpy-state and conflicted with existing brainevent skill boundaries, leaving the validated skill routing graph intact.

File-Level Changes

Change Details Files
Remove misfiled draft reference page for event-driven operators under brainpy-state.
  • Delete the markdown file that contained only planning scaffold sections and no real reference content
  • Eliminate dead outgoing links from this page to non-existent references
  • Resolve the rule violations around routing and skill territory by removing this misfiled document
skills/brainpy-state/references/brainstate-dynamics/brain-dynamics-event-driven-operators.md

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

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

@chaoming0625
chaoming0625 merged commit 39d271a into main Jul 29, 2026
3 checks passed
@chaoming0625
chaoming0625 deleted the fix/remove-unrouted-event-operators-stub branch July 29, 2026 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant