Repository navigation
docs(S2): say docstrings and comments plainly - #285
Merged
Merged
Conversation
Rewrite the docstrings and comments that the S2 work added or changed, so that each one leads with what the code does or why, in short sentences with plain word order. Every fact, condition, unit and caveat is kept. Only text changed: each touched file parses to the same AST once docstrings are set aside. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CcpawsJs74cSwFLXkz7ZwW Signed-off-by: F.N. Claessen <claessen@seita.nl>
A check of every rewritten docstring and comment against the code found one false claim (that a failure was always retried before retries were bounded, when there were no retries at all), a capacity comment that read as a community-level capacity rather than each member site's, and smaller shifts: a condition made of a fact, a lost "because", a lost example, a tense slip, a softened "cannot", and a line over the length limit. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CcpawsJs74cSwFLXkz7ZwW Signed-off-by: F.N. Claessen <claessen@seita.nl>
…s2-comments-legible
Coverage Report for CI Build 42492174988Warning No base build found for commit Coverage: 95.932%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsRequires a base build to compare against. How to fix this → Coverage Stats
💛 - Coveralls |
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.
Into the integration branch
dev/s2-frbc-complete(#279), notmain.Answers the review comment on #278 that sentence constructions reduce legibility, and that the problem is widespread. #283 did the changelogs; this does the docstrings and comments.
Scope: every docstring and comment block that the S2 work added or changed (
git diff main...oversrc), rewritten as a whole wherever any line of it changed. About 235 across 16 files. Text outside the diff is left alone.What changed:
Checks:
🤖 Generated with Claude Code
https://claude.ai/code/session_01CcpawsJs74cSwFLXkz7ZwW