Ticket #1662 (closed defect: fixed)
JS Style Guide
| Reported by: | skinner | Owned by: | pottedmeat |
|---|---|---|---|
| Priority: | lowest | Milestone: | 0.9 |
| Component: | Documentation | Version: | 0.3 |
| Severity: | trivial | Keywords: | |
| Cc: |
Description
On the Dojo coding style guide web page, in the "Quick Reference" section, some of the examples in "Convention" column are confusing:
The style guide uses the words "lower" and "upper" in the capitalization examples. The page includes these examples:
lower UpperLower lowerUpper UPPER_LOWER _lowerUpper _upperLower
That seems confusing, since lower sometimes appears capitalized ("Lower" or "LOWER") and upper isn't always capitalized.
Would it be better to just use "foo" and "bar" in the examples instead? Like this:
foo FooBar fooBar FOO_BAR _fooBar
Or, here's another alternative:
lowercase CapWords or CamelCase mixedCase UPPER_CASE _mixedCase
The Python style guide uses "mixedCase", "CapitalizedWords?", "lowercase", and "UPPER_CASE_WITH_UNDERSCORES". See http://www.python.org/dev/peps/pep-0008/