docs: rewrite comments in Simplified Technical English - #15
Merged
Conversation
Rewrite every code comment and docstring across src/, tests/, the docs static assets, and example_projects to follow the ASD-STE100 rules in CLAUDE.md: active verbs, short sentences, no -ing forms, no present perfect, and no vague verbs such as check, verify, or ensure. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
OmerBaddour
marked this pull request as ready for review
August 1, 2026 22:37
OmerBaddour
added a commit
that referenced
this pull request
Aug 1, 2026
main #15 rewrote comments and docstrings in STE, which overlapped three files. Resolutions: - cli/main.py: keep main's docstrings for `compile` and `docs`; keep this branch's "configuration" over the "config" abbreviation for `init`. - core/compiler.py: main's docstring, this branch's summary line. - core/scaffold.py: main's wording for the generated environments.yml comments. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Applies the Simplified Technical English (ASD-STE100) convention added in #11 to every existing comment and docstring in the repo.
Scope
src/clair/**— all module, class, function docstrings and inline commentstests/**— conftest plus all 19 unit test modulessrc/clair/docs/static/{app.js,graph.js,index.html}— JS and HTML commentsexample_projects/**/__schema_config__.py— the only comments in the examplesRules applied: active verbs, ≤20/25-word sentences, ≤3 nouns in a row, no
-ingforms, no present perfect, one meaning per word, and specific verbs in place ofcheck/verify/ensure.Not touched: user-facing strings (CLI help text, error messages, log events, generated SQL comments,
docs=field values) — these are program output, not comments.Verification:
uv run pytest tests/→ 516 passed.ruff checkclean.🤖 Generated with Claude Code