From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 10803 invoked from network); 26 Nov 2004 18:45:23 +0000 Received: from smtp.gentoo.org (156.56.111.197) by lists.gentoo.org with AES256-SHA encrypted SMTP; 26 Nov 2004 18:45:23 +0000 Received: from lists.gentoo.org ([156.56.111.196] helo=parrot.gentoo.org) by smtp.gentoo.org with esmtp (Exim 4.41) id 1CXl5v-0007LD-Gw for arch-gentoo-dev@lists.gentoo.org; Fri, 26 Nov 2004 18:45:23 +0000 Received: (qmail 31033 invoked by uid 89); 26 Nov 2004 18:45:23 +0000 Mailing-List: contact gentoo-dev-help@gentoo.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@gentoo.org Received: (qmail 9086 invoked from network); 26 Nov 2004 18:45:22 +0000 DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:message-id:date:from:reply-to:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:references; b=bhUCbrPTAwCBchz2fl1TV+e8cwqGVV8RDCAUgFLHpw4s3ovB9BSPZ5a2zaa0s/HdYGLdZRmHNsm0lpIC5YAcFQ09zkc3L+CPE4DtbQG6cTSvuPW/CTTRVaJ8zSzqeXTGGtXvcbTR0Ds+aw0M/HNYFjGiqSLyrZvfMJYAMNarrJk= Message-ID: <46059ce10411261045602fecc4@mail.gmail.com> Date: Fri, 26 Nov 2004 13:45:22 -0500 From: Dan Meltzer Reply-To: Dan Meltzer To: gentoo-dev@lists.gentoo.org In-Reply-To: <20041126180351.GA11093@lion.gg3.net> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit References: <3908185A3D2C144E9FAD070D2727FFD81716A9@PERIMAIL.perimed.priv> <1049C878-3D68-11D9-9250-000A958238BC@gentoo.org> <1101226835.9000.39.camel@cgianelloni.nuvox.net> <46059ce104112315265d557064@mail.gmail.com> <1101327015.9848.5.camel@io> <20041125094444.GA13530@lion.gg3.net> <20041126022509.GA26935@ols-dell.iic.hokudai.ac.jp> <20041126101734.59070a9a@snowdrop.home> <20041126180351.GA11093@lion.gg3.net> Subject: Re: [gentoo-dev] Gentoo beeping at me! X-Archives-Salt: d0f277cc-f9dd-49e8-95c8-1e3dfee05f9e X-Archives-Hash: c4192682d9a8415c5fdfeb093c338826 Id prefer to see something like #/// #/ #/ #/ #/// that is, each line that goes into documenetation has a prepending character, so that It is easy to tell it apart without folding, then again, maybe it doesnt need to be told apart... or a more in depth one, something like #/// #/// #///feature name #///a short description of the problem #///a paramater that could be passed to it #/// #/// same as before... #/// that way all documentation can just be extracted as xml... making parsing to a web page, or a man page, or whatever, a lot easier IMO (yes, this was stolen shamelessly from .net's documentation standards :)) On Sat, 27 Nov 2004 03:03:52 +0900, Georgi Georgiev wrote: > maillog: 26/11/2004-10:17:34(+0000): Ciaran McCreesh types > > > > On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev > > wrote: > > | maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types > > | > On Thu, 25 Nov 2004, Georgi Georgiev wrote: > > | > > > | > If you really think that in-line docs are ugly, use vim(1), and > > | > automagically fold them out of your view (:help foldexpr, although > > | > this can be set to happen in the eclass syntax file). I suspect > > | > that most of the people who only occasionally work with the > > | > eclasses, and those who are just starting to use the eclasses, would > > | > find them more useful than ugly. > > | > > | I have nothing against in-line docs in general. I simply had trouble > > | imagining it in the bash case. > > | > > | What about using perldoc itself? Simply prepend every doc line with a > > | '#', then run > > | > > | awk '/^#/ { sub("#",""); print } > > > > In bash? How would that work? > > I imagined > > #=item blah blah > # more POD > # and more > # and more > #=cut > > > Here's another possibility: > > > > # {{{ doc > > # whatever format we decide upon > > # blah blah blah > > # }}} > > > > Doesn't screw up normal comments, really easy to find and process, easy > > to turn into folds in the editor :) > > Sounds great. Now all that's left is to agree upon the format and write > the converter. Oh, and my favorite -- a GLEP maybe? (no, I'm not > sarcastic; just in a good mood ;) ). > > -- > ) Georgi Georgiev ) Hi! I'm Larry. This is my brother Bob, and ) > ( chutz@gg3.net ( this is my other brother Jimbo. We thought ( > ) +81(90)6266-1163 ) you might like to know the names of your ) > ( ------------------- ( assailants. ( > > > -- gentoo-dev@gentoo.org mailing list