aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Entriken <github.com@phor.net>2018-01-30 03:45:36 +0800
committerGitHub <noreply@github.com>2018-01-30 03:45:36 +0800
commit5497a851582c8c0d5407ead926f9041b2701a626 (patch)
treee77c77430b88c2e3841314363b39cfa03145d21e
parentcc1c461fc05255f0efc3a36f6c90336092c66aae (diff)
downloaddexon-solidity-5497a851582c8c0d5407ead926f9041b2701a626.tar.gz
dexon-solidity-5497a851582c8c0d5407ead926f9041b2701a626.tar.zst
dexon-solidity-5497a851582c8c0d5407ead926f9041b2701a626.zip
Clarify name documentation for mixedCase
-rw-r--r--docs/style-guide.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst
index 4c0d44f0..ab1af13d 100644
--- a/docs/style-guide.rst
+++ b/docs/style-guide.rst
@@ -684,7 +684,7 @@ naming styles.
* ``mixedCase`` (differs from CapitalizedWords by initial lowercase character!)
* ``Capitalized_Words_With_Underscores``
-.. note:: When using abbreviations in CapWords, capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError.
+.. note:: When using initialisms in CapWords, capitalize all the letters of the initialisms. Thus HTTPServerError is better than HttpServerError. When using initialisms is mixedCase, capitalize all the letters of the initialisms, except keep the first one lower case if it is the beginning of the name. Thus xmlHTTPRequest is better than XMLHTTPRequest.
Names to Avoid