launchpad-dev team mailing list archive

[Jonathan Lange <jml@xxxxxxxxx>]

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.

jml