Normalize definitions of compiler settings

[nerush]

The goal of this simple community PR is to normalize compiler definitions by capitalizing the first word and adding . at the end of a sentence.

[soronpo]

I guess that it wasn't like that to begin with since some "sentences" are not really complete sentences.

[nerush]

I guess that it wasn't like that to begin with since some "sentences" are not really complete sentences.

Indeed, here is one example:

PhasesSetting("-Ylog", "Log operations during")

Would it not be useful to make them complete?

[odersky]

I agree with soronpo, after all. Complete sentences should get a ., others not. If that's too tedious we could also consider never adding .

Changed opinion

[anatoliykmetyuk]

Otherwise LGTM, thanks for taking the time to improve the docs!

[odersky]

I believe this is getting out of hand. The status quo is better than the fix. We either have to check more carefully where to put the .s or leave them out altogether (which would be the simplest fix).

[odersky]

Don't have dots in nonsensical places.

[nerush]

Thanks, @soronpo @odersky @anatoliykmetyuk for providing valuable feedback.

Don't have dots in nonsensical places.

I will remove dots from incomplete sentences.

[nerush]

Dots are removed from incomplete sentences. They are also removed from definitions, where dots might confuse more than help, e.g:

BooleanSetting("-Yretain-trees", "Retain trees for top-level classes, accessible from ClassSymbol#tree")

If you think removing dots from all definitions is even better for consistency reasons, just let me know and I will fix it asap.