Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Integrates git-blame output into YARD's method source display.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
template/default
.gitignore
Gemfile
LICENSE
README.textile
Rakefile
yard-blame.gemspec

README.textile

yard-blame

A YARD plugin to add git-blame output to documentation.

Usage


gem install yard-blame
yardoc --plugin blame

TODO

  • The main thing is to make it more efficient by not running git-blame for every method.
  • Code cleanup: not sure I like the git_blame code being in the template, but perhaps that’ll be fixed by the above.
  • Some kind of visual indicator of how recent a change might be good.
  • Integration with a commit viewer would be neat, but is starting to get out of scope of this plugin.
Something went wrong with that request. Please try again.