Re: [lmi] Style guide

[Greg Chicares]

On 2018-02-24 12:58, Vadim Zeitlin wrote:
> 
>  Seeing the commits changing the names of the member variables made me
> realize that I never finished writing the style guide where I wanted to
> collect all the coding conventions for lmi. However it does contain a few
> useful things already (and probably misses many others, but I have to admit
> that I started writing it such a long time ago, that I don't even remember
> any more what did I plan to add to it) and I wonder if it could be useful
> to commit it to lmi repository even in its current, unfinished state. To
> give you an idea of what's there, I've created
> 
>       https://github.com/vadz/lmi/wiki/Style-guide

I'd be inclined to commit it immediately, except that...

> with the contents of this Markdown file.

...it's in Yet Another Format. I want to be able to modify it myself,
and I have no wish to learn another markup language. I understand the
argument that this is "Rich Text Format Done Right", but consider me an
intransigent markup counter-revolutionary: please don't object if I
translate it to HTML before the initial commit.

I assume it's an '.md' file. How would I download it? Use the URL above,
and add an '.md' extension? Or is its source available at some direct URL?
(I tried viewing the HTML source, but it's nasty.)

>  What do you think, both of its contents and of the idea of committing it?

As recently as today I consulted my local copy of an ancient lmi style
guide that cannot be published as is for copyright reasons. We've wanted
a publishable guide for many years, and this is obviously a big step
forward. As to the detailed contents, I'd rather scrutinize them
carefully as time permits.