Add YARD documentation to ruby-git #502
Merged
Conversation
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
Signed-off-by: James Couball <jcouball@yahoo.com>
jcouball
commented
Dec 28, 2020
| opts[:working_directory] ||= working_dir | ||
| opts[:repository] ||= File.join(opts[:working_directory], '.git') | ||
| # (see Git.init) | ||
| def self.init(directory, options = {}) |
There was a problem hiding this comment.
The arg opts was changed to options to be the same as Git.init so the (see Git.init) YARD directive would work.
| opts[:working_directory] ||= working_dir | ||
| opts[:repository] ||= File.join(opts[:working_directory], '.git') | ||
| # (see Git.open) | ||
| def self.open(working_dir, options={}) |
There was a problem hiding this comment.
The arg opts was changed to options to be the same as Git.open so the (see Git.open) YARD directive would work.
| # See [the --all option to git-add](https://git-scm.com/docs/git-add#Documentation/git-add.txt--A) | ||
| # for more details. | ||
| # | ||
| def add(paths = '.', **options) |
There was a problem hiding this comment.
Change the signature from *args so the individual options can be documented. I am confident that this is equivalent because the unit tests still pass.
3 tasks
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.
Your checklist for this pull request
🚨Please review the guidelines for contributing to this repository.
Description
Create YARD documentation for ruby-git instead of rdoc. Make improvements to the documentation.
Not everything is documented yet. Additional PRs will add YARD doc for everything.
The work done so far shows what this would look like for most methods in the Git module like Git.bare, Git.open, Git.clone, Git.init.
In order to see this updated documentation, you will need to clone this PR branch and then run:
JRuby Not Supported for Generating YARD docs
This project uses the
redcarpetgem to be able to use Markdown to format YARD documentation.redcarpetis not compatible with JRuby.To make this clear, the rake tasks for YARD documentation are not added under JRuby and the
redcarpetgem is not development dependency when running in JRuby.