Emmanuel Blot wrote:
...
What kind of coding rules, you mean the svn:eol-style ?

Yes, among others. Those are things that need to be known before
committing to the SVN repository. The answers to my previous question
(about (c) notices) could fit as well, I believe.
Maybe those are not actual "coding rules", but I think it would be
nice if this information appears somewhere on the web site.

Ah, another convention that comes to mind: the embedded documentation.

There are basically 2 styles:

def abc():
   """One liner, says what abc is about

   Now, more detailled documentation about abc, it's arguments,
   return values, etc.
   """


And:

def abc():
   """
   This is abc's doc. Please read on...
   """

There were several back and forth changes between these 2 styles.
I think the first one should be preferred, although there are still areas
where the second one is prevalent (e.g. trac/versioncontrol/api).

Comments?

-- Christian
_______________________________________________
Trac-dev mailing list
[email protected]
http://lists.edgewall.com/mailman/listinfo/trac-dev

Reply via email to