[Thuban-list] Patch: classifiers

[Bernhard Herzog]

"Daniel Calvelo Aros" <dcalvelo at minag.gob.pe> writes:

> - Use '\' systematically for line breaks?

Only where necessary.  In most cases where one needs to split a logical
line over several physical lines the implicit rules for line joining
make it unnecessary.  In the other cases it's usually easy to introduce
and extra pair of parentheses.

> - Blank lines within code blocks to enhance readability, for code sections,
> algorithm phases, etc.?

Yes.

> - Use c_style_caps_as_in_gtk for helper functions but SmalltalkLikeMixedCaps
> for classes and class members?

More or less.  I prefer lower cases names for non-public methods,
though.  So CamelCase with an upper case first letter for classes,
public methods and package names.  lowercase_with_underscores for
functions, variables, interfaces for derived classes and module names.
_leading_underscore_and_lowercase for more private things.
__double_leading_undescore only where there's a somewhat higher chance
of accidental name clashes in derived classes.  ALL_UPPERCASE for
constants.


> - TODO, FIXME or XXX marks for pending stuff?

Yes.

> - Any guidelines on code comments? One or two ##?

One

> doxygen-like openings?

The kind of information that would be extracted by a tool like doxygen
is in the doc-strings.


> - Adhere to StructuredTextNG in docstrings?

I sometimes use formatting taken from an earlier StructuredText version,
but usually I don't bother with it.

> Jan, in the on-line version, there is a weird phrase: " The isn't adhered to
> in the code as well as it should. ", and a reference to my HSV patch which
> shouldn't be there, IMO.

Removed.

> The point Bernhard made about 2.2 compatibility is
> VERY important. Please include it.

Added.

> Do you think this should be in CVS? I'd vote yes,

+1.  It should be in a directory under Doc.

> with a reference to it in
> the README. HTML? STNG?

Simple plain text.  If we need more than that we could adopt a format
like the one used by the Python PEPs.  We don't need to be as formal at
this point, of course.

These patch submission guide lines are actually more coding guide lines.
There's only one paragraph that's specific to patches.

   Bernhard

-- 
Intevation GmbH                                 http://intevation.de/
Skencil                                http://sketch.sourceforge.net/
Thuban                                  http://thuban.intevation.org/