docs: strip issue refs and migration narrative from docstrings (#771) - #777
Merged
Conversation
Docstrings across the package carried tracker references (#NNN, cellpy-core#NNN, epic/decision/Stage codes) and "what it used to be in which issue" narrative that rendered into the public API docs. Readers of the API reference do not need the change history; issue references belong in comments/git, not in docstrings. Removes issue references and migration commentary from ~185 docstrings in 100 modules, keeping all substantive API description intact. Also drops one user-facing NotImplementedError message's "in B4 (#708)" epic reference in cellpy/collect/collector.py. No behaviour change; 100 files touched, docstrings only (plus the one error string). Package imports clean and tests/test_collectors.py passes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The repository card's release tag is fetched from the live GitHub API at view time, so older RTD-built versions still show the newest release. Document this as expected in dev_docs.md; the RTD version switcher is the source of truth for which docs you're on. Closes #776 (wontfix). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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
1 participant
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.
Closes #771. Also documents and closes #776 (RTD header release-badge behaviour).
What
Docstrings across the package carried tracker references (
#NNN,cellpy-core#NNN, epic/decision/Stage codes) and "what it used to be, in whichissue" narrative that rendered straight into the public API docs. Readers of the
API reference don't need the change history — issue references belong in
comments/git, not in docstrings (#771).
100 modules, keeping all substantive API description intact.
NotImplementedErrormessage'sin B4 (#708)epicreference in
cellpy/collect/collector.py.dev_docs.mdnote explaining the header repo-card release badge isfetched live from GitHub (independent of the RTD-built version) — the RTD
version switcher is the source of truth (Docs: GitHub header shows latest release even when viewing older RTD versions #776, documented as expected).
Not a behaviour change
Docstrings only (plus the one error string and one docs note). Verified:
import cellpyclean in the uv env.tests/test_collectors.pypasses (18).Release
Docs-only, no code behaviour change → ships as a post-release
v2.1.0.post1(milestone
v.2.1.0.post1), afterv2.1.0is tagged. Does not gate thev2.1.0release.🤖 Generated with Claude Code