docs(brainpy-state): remove unrouted event-driven operators stub - #9
Merged
Merged
Conversation
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.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
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.mdwas 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:
skills/brainpy-state/against every routing mention inSKILL.mdand all references. This file was the only one absent from every routing row — a rule 20 violation.## Used byblock namedreferences/brainstate-dynamics/dynamics-and-integration.mdandreferences/brainstate-dynamics/brain-dynamics-snn-workflows.md. Neither has existed in any commit in this repository (git log --all --diff-filter=Afinds no addition of either).EventLinear,EventFixedProb,FixedNumConn,EventFixedNumConn— is owned byskills/brainevent/, whichSKILL.md:207already 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:723places this reference underskills/brainstate/, notskills/brainpy-state/. It was misfiled in the original draft, which explains why nobrainpy-staterouting row ever pointed at it. That plannedbrainstatereference 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.mdis a finished, rule-21-conforming reference, routed fromreferences/projection-patterns.md:134. It andscripts/training-snn.pyare unaffected.Verification
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: