lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"

http://yardoc.org

MIT License

1.92k stars 394 forks source link

Links YARD::CLI::Yardoc to api reference #1512

Open alvincrespo opened 9 months ago

alvincrespo commented 9 months ago

Description

This PR updates the README to link YARD::CLI::Yardoc to https://rubydoc.info/gems/yard/YARD/CLI/Yardoc#label-Options+File+-28.yardopts-29. I'm proposing this change to help others find how to create a valid .yardopts file quickly.

Completed Tasks

[x] I have read the Contributing Guide.
[x] The pull request is complete (implemented / written).
[x] Git commits have been cleaned up (squash WIP / revert commits).
[ ] I wrote tests and ran bundle exec rake locally (if code is attached to PR).

alvincrespo commented 8 months ago

@lsegal Thanks for the approval! Anything I should do to get this merged?