docs: add .yardopts so yard and rake doc agree - #48
Merged
Conversation
The YARD options lived only in the Rakefile's YardocTask, so a bare `yard` from the command line produced different documentation than `rake doc`: the Rakefile passed --no-private, a plain `yard` did not, and neither had a --readme, --title, or extra-file list. Move the options into .yardopts as the single source of truth and let the YardocTask pick them up, matching the other test-kitchen drivers. Also drop the redundant file glob from :doc_coverage so it reads .yardopts too. Switching from --no-private to --private/--protected widens the surface YARD reports on from 9 methods to 23. All 23 are documented, so coverage stays at 100%. Co-Authored-By: Claude Opus 5 (1M context) <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
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.
What
The YARD options lived only in the Rakefile's
YardocTask, so a bareyardfrom the command line produced different documentation thanrake doc:--no-private, a plainyarddid not--readme, a--title, or an extra-file listThis adds
.yardoptsas the single source of truth and lets theYardocTaskpick it up, matching the other test-kitchen drivers. The redundantlib/**/*.rbglob is dropped from:doc_coverageso that task reads.yardoptstoo.Note on
--privateSwitching from
--no-privateto--private/--protectedwidens the surface YARD reports on from 9 methods to 23. All 23 are already documented, so coverage stays at 100% — this just stops hiding two thirds of the driver from the generated docs.Verification
yardandyard stats --list-undocnow return identical output:rake -Tstill lists both tasks:Docs-only change — no
lib/orspec/files touched.🤖 Generated with Claude Code