[Buildbot-devel] Where to document existing buildsteps?

Charles Lepple clepple at gmail.com
Sun Jan 31 00:18:44 UTC 2010


On Thu, Jan 28, 2010 at 9:53 AM, Dustin J. Mitchell <dustin at zmanda.com> wrote:
> On Thu, Jan 28, 2010 at 7:13 AM, Charles Lepple <clepple at gmail.com> wrote:
>> I was tinkering with WarningCountingShellCommand, and ran into the
>> classic Python re.match vs re.search issue. I don't see this class in
>> the user manual, and the epydoc-format documentation just inherits the
>> documentation from the superclass.
>
> It should be documented in the manual, if you want to write that up.
> Otherwise, adjusting the epydoc is fine.

There is actually a fair amount of documentation for the warning
regexes in the manual - I just was looking for
'WarningCountingShellCommand' instead of its subclass 'Compile'.

With that in mind, I added a reference to the superclass and mentioned
match/search in the manual. I'll look at epydoc later.

-- 
- Charles Lepple




More information about the devel mailing list