Received: from localhost (maia-5.hub.org [200.46.204.182]) by postgresql.org (Postfix) with ESMTP id DA1069FB454; Fri, 8 Jun 2007 08:57:36 -0300 (ADT) Received: from postgresql.org ([200.46.204.71]) by localhost (mx1.hub.org [200.46.204.182]) (amavisd-maia, port 10024) with ESMTP id 84499-01; Fri, 8 Jun 2007 08:57:21 -0300 (ADT) X-Greylist: from auto-whitelisted by SQLgrey-1.7.4 X-Greylist: from auto-whitelisted by SQLgrey-1.7.4 Received: from sipala.earlham.edu (sipala.earlham.edu [159.28.1.75]) by postgresql.org (Postfix) with ESMTP id E9D489FB40C; Fri, 8 Jun 2007 08:57:27 -0300 (ADT) Received: from [159.28.7.5] (ec454.lly.earlham.edu [159.28.7.5]) (authenticated bits=0) by sipala.earlham.edu (8.13.6/8.13.6) with ESMTP id l58Bv04F000712 (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NO); Fri, 8 Jun 2007 07:57:01 -0400 (EDT) X-Authentication-Warning: sipala.earlham.edu: Host ec454.lly.earlham.edu [159.28.7.5] claimed to be [159.28.7.5] In-Reply-To: References: <20070606164029.GB11800@alvh.no-ip.org> <46670885.1050207@hagander.net> Mime-Version: 1.0 (Apple Message framework v752.3) Content-Type: text/plain; charset=US-ASCII; delsp=yes; format=flowed Message-Id: Cc: Magnus Hagander , Alvaro Herrera , PostgreSQL WWW List , PostgreSQL Documentation List Content-Transfer-Encoding: 7bit From: Kevin Hunter Subject: Re: [DOCS] Users comments don't migrate to docs for new version? Date: Fri, 8 Jun 2007 07:56:33 -0400 To: Nikolay Samokhvalov X-Mailer: Apple Mail (2.752.3) X-Virus-Scanned: Maia Mailguard 1.0.1 X-Archive-Number: 200706/17 X-Sequence-Number: 12056 At 5:18p -0400 on 07 Jun 2007, Nikolay Samokhvalov wrote: > But I suppose there are some cases when it's not possible to move the > comment to the main text -- e.g. if the comment concerns too narrow > area, is very specific and is useful not for all people (but still > useful for some!). > > Moreover, moving good comments to the main text makes the text bloated > -- what if we have 10 examples of using function aaa() and all of them > are illustrations for different areas? We (ok, sorry, Tom because only > he knows English) will choose only 1 of them to avoid bloating of the > main text, even if all 10 use cases has some specific features... Hrm. If they're still good comments, what about including a hyperlink to a pop-up or separate page with some specific information about that particular point? ("There is more discussion on the many uses of the function aaa()") Bloat for the main documentation could still avoided, but if read on- line (as the docs are meant to be read?) then access to other's wisdom need not lost/weeded out. > I could help with (yeah, not with reworking comments -- I do not know > English well :-) ) creating a simple patch that adds a notice "this > comment was originally created for version 8.0" and maybe something Although, short of above, perhaps this'd be an easier en masse solution? > BTW, then we would add some marking/rating system to the comments > to allow other users see what comment is really useful. Kind of like digg or something? Where the higher-rated float to the top? Kevin