[gobolinux-users] Gobo wants you! (to comment its scripts

[Aitor Pérez Iturri]

Hi all,
I think that at least bash source libraries files should have a header
in each function which could easily parsed by a little script, so you
could generate the wiki output or man pages from it. 
Something like this:

#####################
# Function: name
# Description
# Input:
#	a : description
#	b : description
# Output: description
# Example:
######################

I think this way we could export easily functions avaible in the
GoboLinux system.

At the end of the file should have also a little description telling
what the bash file is intended for, something like:

#################################################
# File: file_name
# Description:
# "here the description of the bash librery file"
# Usage:
# "usage of the file"
#################################################

Could be added also the name of the main dev of the file if developers
want that.

Dunno what are the python specific comments, and i think that using
docstring for python functions is nice, but will be nice to have the
same file header talking about the file pourpose that bash ones.

Of course comments format could be different.

Thanks, Aitor

-- 
If the kids are united they will never be divided!