@perlun CONTRIBUTING.md says that this project requires YARD documentation (even before I rewrote it), but YARD was not really used at all. RDoc was used inconsistently.

I was wondering if you thought it would be a good idea to add YARD documentation?

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 jcouball/ruby-git, and then run:

bundle install
bundle exec rake yard && open doc/index.html

Two areas to look at are the Git module and the Files page (accessed by clicking the 'Files' link in the top left under where it says 'Class List'.

One interesting thing is that documenting the project has given me some good ideas for refactoring parts that are a little confusing.

Today I learned that RubyGems automatically generates and hosts documentation for every gem published to rubygems.org at https://rubydoc.info. For instance: https://rubydoc.info/gems/git

@jcouball No strong feelings from my end as to whether to go with RDoc or YARD. I've used the latter previously myself though. In any case, we should definitely make it look good at https://rubydoc.info/gems/git

A friendly reminder that this issue had no activity for 60 days.

I recreated this PR in #502