commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject Re: [math] Formatting
Date Thu, 23 Aug 2012 13:08:16 GMT
On 23 August 2012 12:52, Gilles Sadowski <gilles@harfang.homelinux.org> wrote:
> On Thu, Aug 23, 2012 at 01:25:42PM +0200, Thomas Neidhart wrote:
>> On Thu, Aug 23, 2012 at 1:16 PM, S├ębastien Brisard <
>> sebastien.brisard@m4x.org> wrote:
>>
>> > Hi,
>> >
>> > >
>> > > Probably easiest to use the Wiki for this, at least initially.
>> > >
>> > I'm not very fond of the Wiki: maybe I could just start a JIRA ticket,
>> > that would allow recording our discussions.
>> >
>> > > If there are compulsory rules - e.g. no tabs - a reason should be
>> > > given, for example:
>> > > Tab settings vary. This causes alignment issues, so tabs are banned.
>> > >
>> > > Generally it's easier to understand and follow rules if their purpose
>> > > is made explicit.
>> > >
>> > OK, so for all rules, we will try to provide a reason.
>> >
>>
>> It would be nice to have something in common for all commons (sic!)
>> components ;-)
>>
>> It is somehow odd that one has to switch coding style when working on
>> different components
>
> That's certainly strange, but the fact is that the Commons components do not
> have much in common...  The codes live separate lives (dependencies, even to
> "sibling" Commons components, is forbidden for CM), and nothing is more tied
> to code than its formatting: I mean, conventions vary slightly from project
> to project, and "Commons" cannot be considered a single programming project.
>
> Let's agree that it would be nice to have a single set of conventions within
> a "src" subdirectory of the repository. [That's already enough to generate a
> sizeable amount of discussions...] ;-)
>

Maybe one way to approach this is to start by listing what types of
formatting conventions are subject to rules.
Within a component each component can decide the exact implementation.

For example, consistent indentation within a file is obviously very
important for readability (vital for Python!).
It's not essential that all components have the same indentation,
though obviously it makes things easier.
In fact, it may be useful to use different indendation levels for
different file types.
XML generally uses more levels of indentation than Java, so having a
smaller indentation makes sense for XML.


> Gilles
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message