Conversation
Nothing in this repository carried API documentation beyond a stray author tag. Every method now has a YARD comment covering what it does, what it takes, what it returns, and -- where it matters -- why it is written the way it is. `yard stats --private` reports 100% documented. `rake doc` generates the HTML into `doc/`, which is already gitignored. yard sits in the `:development` bundler group, which CI omits when it runs the tests, so the Rakefile only defines the real task when yard is installed and otherwise leaves a stub that says how to get it. **Nothing in CI gates on documentation**, and `rake test` still works with the group omitted -- verified by running it under `BUNDLE_WITHOUT=development`, the same setting the shared workflow uses. Signed-off-by: Tim Smith <tsmith84@proton.me>
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.
docs: document every method with YARD and add a docs rake task
Nothing in this repository carried API documentation beyond a stray author tag.
Every method now has a YARD comment covering what it does, what it takes, what
it returns, and -- where it matters -- why it is written the way it is.
yard stats --privatereports 100% documented.rake docgenerates the HTML intodoc/, which is already gitignored.yard sits in the
:developmentbundler group, which CI omits when it runs thetests, so the Rakefile only defines the real task when yard is installed and
otherwise leaves a stub that says how to get it. Nothing in CI gates on
documentation, and
rake teststill works with the group omitted -- verifiedby running it under
BUNDLE_WITHOUT=development, the same setting the sharedworkflow uses.