Updated Nimrod Enhancement Proposal #1 (markdown)
This commit is contained in:
parent
8598614a3c
commit
c416256f15
|
@ -10,7 +10,7 @@ proposal aims to list a series of guidelines that the standard library should
|
||||||
follow. Note that these are *guidelines* only. The nature of Nimrod being
|
follow. Note that these are *guidelines* only. The nature of Nimrod being
|
||||||
as flexible as it is, there will be parts of this style guide that don't make
|
as flexible as it is, there will be parts of this style guide that don't make
|
||||||
sense in certain contexts. Furthermore, just as
|
sense in certain contexts. Furthermore, just as
|
||||||
(Python's style guide)[http://legacy.python.org/dev/peps/pep-0008/] changes
|
[Python's style guide](http://legacy.python.org/dev/peps/pep-0008/) changes
|
||||||
over time, this style guide will too.
|
over time, this style guide will too.
|
||||||
|
|
||||||
Style Guidelines
|
Style Guidelines
|
||||||
|
@ -19,12 +19,12 @@ Style Guidelines
|
||||||
General
|
General
|
||||||
-------
|
-------
|
||||||
- All identifiers, except for types, should be in pascalCase. Type identifiers
|
- All identifiers, except for types, should be in pascalCase. Type identifiers
|
||||||
Should be in CamelCase.
|
should be in CamelCase.
|
||||||
|
|
||||||
- Members of enums should have an identifying prefix before their
|
- Members of enums should have an identifying prefix before their
|
||||||
names. For example, the PathComponent enum in the os module contains the
|
names. For example, the PathComponent enum in the os module contains the
|
||||||
pcFile member, which, like the other members, has the 'pc'
|
pcFile member, which, like the other members, has the 'pc'
|
||||||
(standing for PathComponent) prefix before its name.
|
(standing for PathComponent) prefix before its name. An exception to this rule exists when using ``pure`` enums.
|
||||||
|
|
||||||
- Lines should be no longer than 80 characters
|
- Lines should be no longer than 80 characters
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue