That was interesting. I love the TRS-80 mention. So, it seems your
logic is pretty much the same as ours --- trim them up and improve the
docs.
So, that particular URL was an example of what _not_ to do. I have
heard folks say they like the PHP comments a lot, but I wonder how much
of that is t
When I first saw this thread I thought of the PHP docs which I recently started
using, from a level of knowing absolutely nothing of PHP.
Sure there was some useful stuff in some of the comments but some of the pages
were very long, far more comment than manual page. A lot of the comments refer
t
On Monday, February 3, 2003, at 04:39 AM, Bruce Momjian wrote:
I looked at that URL, and it is good example of what _not_ to do with
interactive docs, IMHO. The manual page is _very_ short, and shows no
examples. The comments have various examples/cases, with corrections
later to earlier postin
> -Original Message-
> From: Tom Lane [mailto:[EMAIL PROTECTED]]
> Sent: 03 February 2003 14:39
> To: Dave Page
> Cc: Bruce Momjian; Neil Conway; PostgreSQL Hackers
> Subject: Re: [HACKERS] Interactive Documentation - how do you
> want it towork?
>
>
>
"Dave Page" <[EMAIL PROTECTED]> writes:
> Perhaps we should then prune the garbage out of the old version, and
> make the comments version specific so that we start afresh with the new
> docs, but leave the useful comments against the older versions?
It seems clear to me that the comments *should*
> The only effort required would be to note and delete the 'junk' comments
> which is minimal work, especially if going through them anyway. There is
> no web interface for deletion (yet) but it will identify the comment IDs
> for you. I'm happy to accept lists of items to delete.
Toss an 'Send no
> -Original Message-
> From: Bruce Momjian [mailto:[EMAIL PROTECTED]]
> Sent: 03 February 2003 13:04
> To: Dave Page
> Cc: Neil Conway; PostgreSQL Hackers
> Subject: Re: [HACKERS] Interactive Documentation - how do you
> want it towork?
>
> > Perhaps we
Dave Page wrote:
>
> > -Original Message-
> > From: Bruce Momjian [mailto:[EMAIL PROTECTED]]
> > Sent: 03 February 2003 11:40
> > To: Dave Page
> > Cc: Neil Conway; PostgreSQL Hackers
> > Subject: Re: [HACKERS] Interactive Documen
Dave Page wrote:
> > I looked at that URL, and it is good example of what _not_ to
> > do with interactive docs, IMHO. The manual page is _very_
> > short, and shows no examples. The comments have various
> > examples/cases, with corrections later to earlier postings.
> > I would think this
Bruce Momjian wrote:
> I looked at that URL, and it is good example of what _not_ to do with
> interactive docs, IMHO. The manual page is _very_ short, and shows no
> examples. The comments have various examples/cases, with corrections
> later to earlier postings. I would think this is not what
> -Original Message-
> From: Bruce Momjian [mailto:[EMAIL PROTECTED]]
> Sent: 03 February 2003 11:40
> To: Dave Page
> Cc: Neil Conway; PostgreSQL Hackers
> Subject: Re: [HACKERS] Interactive Documentation - how do you
> want it towork?
>
>
>
> I l
example.
>
> Regards, Dave.
>
>
> > -Original Message-
> > From: Bruce Momjian [mailto:[EMAIL PROTECTED]]
> > Sent: 03 February 2003 01:09
> > To: Dave Page
> > Cc: Neil Conway; PostgreSQL Hackers
> > Subject: Re: [HACKERS] Interactive Documentation -
, Dave.
> -Original Message-
> From: Bruce Momjian [mailto:[EMAIL PROTECTED]]
> Sent: 03 February 2003 01:09
> To: Dave Page
> Cc: Neil Conway; PostgreSQL Hackers
> Subject: Re: [HACKERS] Interactive Documentation - how do you
> want it towork?
>
>
>
>
gt; > 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 examp
Dave Page wrote:
> 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
Folks, we want organized documentation, not cudos to commentors or
something that is so large that people have to wade through the comments
to see if something is interesting. The focus is the docs, and the
comments are only there to improve the docs. They are there for no
other reason.
---
Yes, please delete the old comments. We want to merge as many in as we
can, and remove the rest.
---
Dave Page wrote:
>
> As you may have noticed we have recently revamped the Interactive
> Documentation on the website (ht
> While we're talking about modifications to idocs, why not have a rating
> system for the usefulness of a comment.
Comment ratings could be useful if the rating is tied to a doc version.
A very useful 7.1 comment may be a little antiquated for 7.3. This
would solve almost all of the issues if c
On 2 Feb 2003, Neil Conway wrote:
> On Sun, 2003-02-02 at 15:22, Dave Page wrote:
> > - Each comment attaches only to the page name, version of the page to
> > which it was submitted *and* subsequent versions (this is the current
> > behaviour).
> >
> > - Each comment should attach to the page
> -Original Message-
> From: Neil Conway [mailto:[EMAIL PROTECTED]]
> 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 a
On Sun, 2003-02-02 at 15:22, Dave Page wrote:
> - Each comment attaches only to the page name, version of the page to
> which it was submitted *and* subsequent versions (this is the current
> behaviour).
>
> - Each comment should attach to the page name to which it was submitted
> regardless of
As you may have noticed we have recently revamped the Interactive
Documentation on the website (http://www.postgresql.org/docs). This has
raised a couple of questions about how the idocs should work, so I'd
like to get some votes on the following 2 issues:
1) How should comments be linked to docu
22 matches
Mail list logo
