On 31 December 2013 14:05, John Myles White <[email protected]> wrote:
> (4) Using both tabs and spaces is a huge problem in a shared codebase.

Irrelevant, as I never argued for mixing tabs and spaces.


> (7) + (8) These rules are part of the official Google style guides for R, 
> which is the language with the most similarity to Julia that’s being used at 
> companies with public facing style guidelines. I think they’re quite sensible 
> rules, which is why I decided to borrow them from published standards.

I don't think that argument holds water. At all. Google rules are not
R rules, and R is not Julia. Companies and projects often have very
specific style guides, while entire languages rarely do.


> (18) + (19): This is clearly an area of big disagreement in our community. I 
> might pull them out into a suggestions section since ...

Suggestions section? As opposed to what? The "mandatory" section? You
cannot force people to code the way you like. The entire document will
only ever be a suggestion section unless you convince Stefan et al to
reject code submitted to Julia that doesn't fit your style guide.


> (31): Comments aren’t PDF’s or HTML or any other language designed for 
> transmitting carefully formatted documents.

Well, HTML is not designed for carefully formatted documents anyway.
But that's beside the point, I didn't say that I embed HTML in my
comments. I do not. I write documentation in Markdown and I'm thinking
of trying AsciiDoc.


> I find diagrams are an essential part of good documentation.

Depends on what you are documenting and for whom. For the things I
choose to put in my source files, I do not need diagrams.

> I think conflating documents with code leads to documents that are less 
> readable and lots of lines in code that’s not actually worth reading.

This is your personal preference. I very much like my style, and I do
not find it difficult to scroll down to the code section of the file.
Clearly you are happy doing things differently from me.


Cheers,
Daniel.

Reply via email to