Open astrieanna opened 9 years ago
I fully agree with this proposal. Since my long-term goal is to see something like juliafmt
get written, I think we should try to keep two parts of this proposal separate:
I'm happy to adopt both, but we can only hope to enforce rules that don't depend upon natural language processing technologies.
This is just a suggestion, based on something I liked at Google:
Block comments should be separated from the
#
by a space. Inline comments should be separated from the preceding code by two spaces, and from the#
by one space. All comments should be written as full sentences. If an inline comment is just a phrase, it should still start with a capital letter and end with a period. (Variable/etc names in comments should keep their actual capitalization, even at the start of a comment.)Good style: