launchpad-dev team mailing list archive

[Julian Edwards <julian.edwards@xxxxxxxxxxxxx>]

On Thursday 06 October 2011 14:47:31 Jonathan Lange wrote:
> On Thu, Oct 6, 2011 at 2:41 PM, Julian Edwards
> 
> <julian.edwards@xxxxxxxxxxxxx> wrote:
> > On Thursday 06 October 2011 09:03:26 Benji York wrote:
> >> I have never gotten much out of API documentation, especially
> >> generated
> >> API documentation.  I can read the code about as quickly as I can read
> >> API docs and reading code makes it easier to drill down into the
> >> contents of a function/method when the need arises.
> > 
> > I think we're conflating two types of documentation here, api docs and
> > conceptual docs.  I think we should continue with the current way that
> > we use for api docs; that is docstrings and pydoc.
> 
> Count me out of that "we". I know they're different, but I reckon we
> need a fairly small amount of the "conceptual" kind.

Ok.

I am mostly referring to all the stuff we're writing about LongPoll at the 
moment, which most people will find alien along with RabbitMQ.  Also, Soyuz, 
not many people know about how that works, so I'm writing a huge amount of 
docs (at Francis' request) about it.