← Back to team overview

launchpad-dev team mailing list archive

Re: To wiki or not to wiki

 

On Friday 07 October 2011 20:35:40 Robert Collins wrote:
> On Fri, Oct 7, 2011 at 8:19 PM, John Arbash Meinel
> 
> <john@xxxxxxxxxxxxxxxxx> wrote:
> > The only thing I want to point out is that if docs are in-tree, you
> > can do "grep -rnI OldAPI" to update the callers of your api, and to
> > notice that there is some documentation about the old api that should
> > be updated.
> > 
> > It is quite a bit harder to do that if the docs are in the wiki, but
> 
> > that might fall under:
> How is it harder?

IMO it's not harder, but very much more convenient.

If you're grepping the tree for invocations of "foo()" then it'll bring up 
documentation at the same time, which reminds you to update it.


Follow ups

References