Project

yard-blame

0.0
No commit activity in last 3 years
No release in over 3 years
Who wrote that code? When? Why? Theses are all things we often ask when reading documentation. yard-blame makes it easy to ask.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
 Project Readme

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.