Repository navigation
Document every public class, method and function (hardening 4) - #122
Merged
Merged
Conversation
The 93 public definitions in src/flahax without a docstring now say what they return or represent. Ruff checks D101-D103 for src/ in the CI style job, and tests/test_public_docstrings.py checks the same with no dependencies, so a new public definition needs a docstring. Eight comment paragraphs that the 3b rewrap broke mid-sentence are reflowed with the same words. CONTRIBUTING notes the rule, and API_REFERENCE.md is regenerated with the new docstrings.
rafatahmed
added a commit
that referenced
this pull request
Nov 7, 2026
Document every public class, method and function (hardening 4)
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.
Hardening 4, following #121: every public definition in the package has a docstring, and two guards keep it that way.
What changed
src/flahax, covering 43 classes, 16 methods and 34 functions. Each says what the definition returns or represents and when it raises; the text comes from the code, for example theflahax mixquestion steps and their return values.src/(other folders are excluded), so the CIstylejob enforces them;tests/test_public_docstrings.pyruns the same check without dependencies.API_REFERENCE.mdis regenerated and now shows the new docstrings for public API items.Evidence
main;main.tools/verify_distribution.py;ruff check .andruff format --check .;