Re: Interactive Documentation - how do you want it towork?

From: "Dave Page" <dpage(at)vale-housing(dot)co(dot)uk>
To: "Neil Conway" <neilc(at)samurai(dot)com>
Cc: "PostgreSQL Hackers" <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Interactive Documentation - how do you want it towork?
Date: 2003-02-02 21:26:46
Message-ID: 03AF4E498C591348A42FC93DEA9661B8259BB0@mail.vale-housing.co.uk
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> -----Original Message-----
> From: Neil Conway [mailto:neilc(at)samurai(dot)com]
> Sent: 02 February 2003 20:52
> To: Dave Page
> Cc: PostgreSQL Hackers
> Subject: Re: [HACKERS] Interactive Documentation - how do you
> want it towork?
>
> > 2) Bearing in mind your answer to the previous question, should all
> > the comments be deleted when useful examples have been
> merged into the
> > main documents (remember that the definition of 'useful'
> may vary), or
> > should we only remove the 'junk' ones?
>
> Once the comment's suggestion has been incorporated and the
> docs updated, I think it should be removed. Just like in the
> rest of the documentation, there's no point presenting
> duplicate content to the user, so we should only keep the
> idocs comments that are still relevant. The same goes for
> comments that have no value (e.g. support requests).

My concern here is that what (for example) Bruce decides is not a useful
addition to the docs themselves, maybe something that would have helped
me with some bizarre problem. If we dump *all* the docs after they have
been merged then I might lose that helpful tip.

Also, and perhaps more importantly, the comments will be merged into a
*future* version. If I am running 7.2, I'm going to look at the 7.2
docs, not 7.3.

Regards, Dave.

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Jakub Ouhrabka 2003-02-02 21:53:04 Re: Case Studio II
Previous Message Josh Berkus 2003-02-02 21:23:50 Re: [PERFORM] not using index for select min(...)