Re: [noreply@postgresql.org: coder] - Mailing list pgsql-www

From Magnus Hagander
Subject Re: [noreply@postgresql.org: coder]
Date
Msg-id CABUevExZ5GqjHwBZnXq_5EFSerOjKgDpTcOXs=99kzWiJ2qmTg@mail.gmail.com
Whole thread Raw
In response to Re: [noreply@postgresql.org: coder]  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
Responses Re: [noreply@postgresql.org: coder]  (Stephen Frost <sfrost@snowman.net>)
List pgsql-www


On Tue, Apr 3, 2018 at 5:00 PM, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
Bruce Momjian wrote:
>
> Does anyone know why our documentation comments are often just one word?
> What is causing this?

The form itself is causing it.  Have a look at it:
https://www.postgresql.org/account/comments/new/10/backup.html/

it asks for my name, then my "short description", then "details".  OK,
so my short description is that I'm a coder, and perhaps I don't want to
enter a long description, so I click "save" --> surely the next page
will ask for my comment, right?  (The form does indicate "please fill
out this field" if I leave short desc empty, so by that point I'm
probably annoyed that it's asking for so many personal details.  It's
good that it doesn't *require* my whole bio!).

I think there should a clear separation between the two fields on top
and the two ones at the bottom.  Maybe just a line of text that says
"Please enter your documentation comment below".

Not entirely correct. In this example, "student" was written under "details". And "coder" under short description.

But yes, those fields are clearly badly named. How about we just name them "subject" and "comment"?

--

pgsql-www by date:

Previous
From: Alvaro Herrera
Date:
Subject: Re: [noreply@postgresql.org: coder]
Next
From: Stephen Frost
Date:
Subject: Re: [noreply@postgresql.org: coder]