Joel Granados wrote: > With this comment I have an opinion and a question: > > Question: One rights documentation of a function when the function is > not obvious and when the function is part of the library. right? > More specifically, What are the policies for documenting a function?
I've just realized there is no written policy for coreutils, so have made this change to its HACKING guidelines: >From 635a5b300db1b8d22c000d1adcfc10a4357e5876 Mon Sep 17 00:00:00 2001 From: Jim Meyering <[email protected]> Date: Tue, 2 Jun 2009 07:52:02 +0200 Subject: [PATCH] doc: HACKING: mention the GNU Coding Standards * HACKING (Add documentation): Add a link to the GCS. --- HACKING | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/HACKING b/HACKING index ae43e3a..d58f2d3 100644 --- a/HACKING +++ b/HACKING @@ -261,6 +261,9 @@ When writing prose (documentation, comments, log entries), use an active voice, not a passive one. I.e., say "print the frobnozzle", not "the frobnozzle will be printed". +Please add comments per the GNU Coding Standard: + http://www.gnu.org/prep/standards/html_node/Comments.html + Minor syntactic preferences =========================== -- 1.6.3.1.308.g426b5 _______________________________________________ parted-devel mailing list [email protected] http://lists.alioth.debian.org/mailman/listinfo/parted-devel
