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

Adding guidance on determining Semantic Versioning #8

Merged

Conversation

jeremyf
Copy link
Contributor

@jeremyf jeremyf commented Mar 2, 2020

In looking further at yard diff, I discovered that you can compare
the generated .yardoc directory (or directories) against a built
gem.

The two gem version parameters can each either be a named gem version
OR a path to a generated .yardoc

See https://github.com/lsegal/yard/blob/8e82a8ab27f2e711bf555bb6ba0c037a1eb3ccfb/spec/cli/diff_spec.rb#L178-L179
for specs

In looking further at `yard diff`, I discovered that you can compare
the generated `.yardoc` directory (or directories) against a built
gem.

The two gem version parameters can each either be a named gem version
OR a path to a generated `.yardoc`

See https://github.com/lsegal/yard/blob/8e82a8ab27f2e711bf555bb6ba0c037a1eb3ccfb/spec/cli/diff_spec.rb#L178-L179
for specs
@jeremyf jeremyf requested a review from jrgriffiniii March 2, 2020 13:51
@jeremyf jeremyf added the documentation Improvements or additions to documentation label Mar 2, 2020
@jrgriffiniii jrgriffiniii merged commit fee2fc3 into master Mar 2, 2020
@jrgriffiniii jrgriffiniii deleted the adding-guidance-on-determining-semantic-version branch March 2, 2020 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants