New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open

alvincrespo wants to merge 1 commit into lsegal:main from alvincrespo:docs--readme-link-to-api

alvincrespo commented Sep 30, 2023 •

edited

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

I have read the Contributing Guide.
The pull request is complete (implemented / written).
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).


          Links YARD::CLI::Yardoc to api reference

b86a7ec

lsegal approved these changes

View reviewed changes

Author

alvincrespo commented Oct 30, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment