<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div class="moz-cite-prefix">Dear all,<br>
<br>
Google made a page with styles for different languages they use
for there opensource projects. There is nice documentation for c++
and also (a less annotated ) part for R.<br>
<br>
This and more can be found at:<br>
<a class="moz-txt-link-freetext" href="https://code.google.com/p/google-styleguide/">https://code.google.com/p/google-styleguide/</a><br>
<br>
The links to the programming languages can be found in the left
bottom table on this page.<br>
<br>
I think this information can add valuable information to the
discussion and enriches your knowledge about programming
languages.<br>
<br>
Kind regards,<br>
<br>
Maarten<br>
<br>
<br>
On 03/21/2013 07:49 PM, L.C. Karssen wrote:<br>
</div>
<blockquote cite="mid:514B5635.4050309@karssen.org" type="cite">
<pre wrap="">Dear all,
Maarten started an etherpad instance at <a class="moz-txt-link-freetext" href="http://openetherpad.org/oxx0htdP47">http://openetherpad.org/oxx0htdP47</a>
I've updated the text he and I came up with and reformatted it in Emacs
org-mode, which allows easy export to PDF and HTML (so that we can
easily integrated it in the development website on r-forge as per
Yurii's suggestion).
If I don't see much change in the EtherPad document in the coming days
I'll put the org file and its HTML export in SVN.
Lennart.
On 20/03/13 11:54, Yurii Aulchenko wrote:
</pre>
<blockquote type="cite">
<pre wrap="">Hi Lennart,
Indeed, why do not we set up piratpad; or we can use our SVN, the same
section we have tutorials in - then it will go directly
to <a class="moz-txt-link-freetext" href="http://genabel.r-forge.r-project.org/">http://genabel.r-forge.r-project.org/</a>
I think it is important to have guidelines and I personally will try to
follow them as much as I could.
At the same time, I would like to emphasize that we had the idea that
rules and guidelines should be suggestive, so that even if I do not
comply 100% I can still make it into the project, and then can improve
on the way. See the quote below.
best, Yurii
Quote from
<a class="moz-txt-link-freetext" href="http://www.genabel.org/developers">http://www.genabel.org/developers</a>:
Rules of the game
The documents provided here are meant to help. We are scared to think of
a situation when 'guidelines' and 'rules' prevent people from
contributing to the project, and a willing contributor is discouraged by
just looking at the pile of 'rules'.
On Mon, Mar 18, 2013 at 9:32 AM, L.C. Karssen <<a class="moz-txt-link-abbreviated" href="mailto:lennart@karssen.org">lennart@karssen.org</a>
<a class="moz-txt-link-rfc2396E" href="mailto:lennart@karssen.org"><mailto:lennart@karssen.org></a>> wrote:
Dear all,
I'd like to follow up on something Yurii wrote in the discussion on the
GenABEL tutorial:
On 03/14/2013 09:38 AM, Yurii Aulchenko wrote:
> I agree that full argument names should be preferred. I was just being
> lazy; I am trying to improve. If other people come up with things
> which are "not in good style" we should probably think of a "good
> style rules" document and then ask people to please to follow them.
>
I completely agree with Yurii. In fact, I think we should not only set
guidelines for the style of the code in the tutorial, but more generally
for all R and C/C++ code in the GenABEL project.
What about setting up a shared editing environment (e.g. on
piratepad.net <a class="moz-txt-link-rfc2396E" href="http://piratepad.net"><http://piratepad.net></a>) to work on an initial draft of
these quidelines? Once
they are more or less fixed we can move the document to SVN as part of
the developer documentation.
From my experience over the last few years I think the following points
are the most commonly occurring ones (for any language) that need
harmonisation:
- comma's should be followed by a space
- operators (= + - * etc.) should be surrounded by a space (and in R the
<- operator too)
- a file should always have a newline at the end
- don't use tabs (as everyone seems to have a different setting for the
tab stop): use spaces. How many spaces is up for debate. Of course
Makefiles are exempt from this rule as tabs are mandatory
- style of brackets: is the opening bracket on the same line as the name
of the loop/function or on a new line on its own? (e.g. K&R, Allman or
bsd style)
- always use {} in if clauses/for loops (even if there is only one
statement in the clause/loop
- lines should not be longer than 80 characters (you may call me old
fashioned ;-))
I think most of these can be set as options in modern development
environment. I'm not an Eclipse user, like many of you, but in Emacs
these can easily be set in your .emacs file. We should also provide info
on how to implement these settings in various DEs in our guidelines
document so that new developers can easily use them.
Lennart.
--
-----------------------------------------------------------------
L.C. Karssen
Utrecht
The Netherlands
<a class="moz-txt-link-abbreviated" href="mailto:lennart@karssen.org">lennart@karssen.org</a> <a class="moz-txt-link-rfc2396E" href="mailto:lennart@karssen.org"><mailto:lennart@karssen.org></a>
<a class="moz-txt-link-freetext" href="http://blog.karssen.org">http://blog.karssen.org</a>
Stuur mij aub geen Word of Powerpoint bestanden!
Zie <a class="moz-txt-link-freetext" href="http://www.gnu.org/philosophy/no-word-attachments.nl.html">http://www.gnu.org/philosophy/no-word-attachments.nl.html</a>
------------------------------------------------------------------
_______________________________________________
genabel-devel mailing list
<a class="moz-txt-link-abbreviated" href="mailto:genabel-devel@lists.r-forge.r-project.org">genabel-devel@lists.r-forge.r-project.org</a>
<a class="moz-txt-link-rfc2396E" href="mailto:genabel-devel@lists.r-forge.r-project.org"><mailto:genabel-devel@lists.r-forge.r-project.org></a>
<a class="moz-txt-link-freetext" href="https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel">https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel</a>
--
-----------------------------------------------------
Yurii S. Aulchenko
[ LinkedIn <a class="moz-txt-link-rfc2396E" href="http://nl.linkedin.com/in/yuriiaulchenko"><http://nl.linkedin.com/in/yuriiaulchenko></a> ] [ Twitter
<a class="moz-txt-link-rfc2396E" href="http://twitter.com/YuriiAulchenko"><http://twitter.com/YuriiAulchenko></a> ] [ Blog
<a class="moz-txt-link-rfc2396E" href="http://yurii-aulchenko.blogspot.nl/"><http://yurii-aulchenko.blogspot.nl/></a> ]
</pre>
</blockquote>
<pre wrap="">
</pre>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
genabel-devel mailing list
<a class="moz-txt-link-abbreviated" href="mailto:genabel-devel@lists.r-forge.r-project.org">genabel-devel@lists.r-forge.r-project.org</a>
<a class="moz-txt-link-freetext" href="https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel">https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel</a></pre>
</blockquote>
<br>
</body>
</html>