[Buildbot-commits] [Buildbot] #1839: replace apidocs with something like LXR

Buildbot nobody at buildbot.net
Sat Feb 26 19:08:25 UTC 2011


#1839: replace apidocs with something like LXR
-------------------+---------------------
Reporter:  dustin  |      Owner:
    Type:  task    |     Status:  new
Priority:  major   |  Milestone:  ongoing
 Version:  master  |   Keywords:
-------------------+---------------------
 The apidocs aren't working out very well, for a few reasons:
  * they tend to blur the line between public and private APIs
  * they do not document instance variables very well
  * we have been very inconsistent in writing docstrings
  * they're often wrong
  * they obscure the actual implementation

 I think we'd do better to publish annotate, searchable source code -
 something like http://mxr.mozilla.org/.

-- 
Ticket URL: <http://trac.buildbot.net/ticket/1839>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation


More information about the Commits mailing list