aboutsummaryrefslogtreecommitdiffstats
path: root/docs/style-guide.rst
diff options
context:
space:
mode:
authorKamuela Franco <kamuela.franco@gmail.com>2017-12-09 22:53:40 +0800
committerGitHub <noreply@github.com>2017-12-09 22:53:40 +0800
commitef579617113d10a58cd6fb717f35de7e22c4cfd1 (patch)
tree0ad876329ff5f44034051ff46e8457ec377bb21a /docs/style-guide.rst
parent226bfe5be1f7443e644d2cfd62aac19b56836b8a (diff)
downloaddexon-solidity-ef579617113d10a58cd6fb717f35de7e22c4cfd1.tar.gz
dexon-solidity-ef579617113d10a58cd6fb717f35de7e22c4cfd1.tar.zst
dexon-solidity-ef579617113d10a58cd6fb717f35de7e22c4cfd1.zip
Update style-guide.rst to include enum style
Diffstat (limited to 'docs/style-guide.rst')
-rw-r--r--docs/style-guide.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst
index a438b3d0..5b6f42a2 100644
--- a/docs/style-guide.rst
+++ b/docs/style-guide.rst
@@ -739,6 +739,12 @@ Modifier Names
Use mixedCase. Examples: ``onlyBy``, ``onlyAfter``, ``onlyDuringThePreSale``.
+Enums
+=====
+
+Enums, in the style of simple type declarations, should be named using the CapWords style. Examples: ``TokenGroup``, ``Frame``, ``HashStyle``, ``CharacterLocation``.
+
+
Avoiding Naming Collisions
==========================