genn-team
Improve SynapseGroup documentation
As found by #68, SynapseGroup.out_post isn't documented and neither are SynapseGroup.src or SynapseGroup.trg . As a minimum, should be added to docstring at https://github.com/genn-team/genn/blob/master/pygenn/genn_groups.py#L319
Greeting @neworderofjamie
I’m Sahil Kumar. I’d like to open a documentation-only Draft PR to address #68 by adding clear, authoritative docs for SynapseGroup.src, SynapseGroup.trg, and SynapseGroup.out_post in pygenn/genn_groups.py.
Planned deliverables
-
NumPy-style docstrings for src, trg, out_post: one-line summary, accepted types/shapes, defaults, and runtime side-effects.
-
Quick local Sphinx build check to confirm the API pages render correctly.
-
Parameter validation notes in docstrings: what the code accepts vs. what will raise.
-
Edge-case examples ( scalar vs per-synapse arrays) so contributors don’t guess behavior.
-
Cross-references: short links in docstrings to related classes/APIs ( SynapsePopulation, model run flow).
-
Performance note: brief note if e.g., using large per-synapse arrays affects memory.
-
PR checklist included in the PR description for maintainers: “docs-only”, tests run, Sphinx verified, ready for review.
-
Small, single-commit branch: docs/synapsegroup-docs and PR titled docs: document SynapseGroup.src/trg/out_post (fix #68).
No runtime behavior changes — docs, tiny tests, and small hygiene fixes only.
If this looks good, please assign me to the issue or reply “go ahead” and I’ll open the Draft PR.
