Skip to content
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.

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

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

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

alvincrespo
Copy link
Contributor

@alvincrespo alvincrespo commented Sep 30, 2023

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.

rendered here

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).

@alvincrespo
Copy link
Contributor Author

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

@lsegal lsegal merged commit cd3ff8a into lsegal:main Aug 26, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants