aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorchriseth <chris@ethereum.org>2018-02-20 01:59:50 +0800
committerGitHub <noreply@github.com>2018-02-20 01:59:50 +0800
commit39f09a90f0aa6ecbba2639c08c77b7a077be5d43 (patch)
tree5ae2710dceffcf3dfad2cb75d13c48ab58a382ab
parentabc23ac6086fe724b82eb8ca7f9805cf7ff5ba10 (diff)
parent5497a851582c8c0d5407ead926f9041b2701a626 (diff)
downloaddexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.tar
dexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.tar.gz
dexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.tar.bz2
dexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.tar.lz
dexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.tar.xz
dexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.tar.zst
dexon-solidity-39f09a90f0aa6ecbba2639c08c77b7a077be5d43.zip
Merge pull request #3448 from fulldecent/patch-8
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