diff options
Diffstat (limited to 'docs/CodingStandards.rst')
| -rw-r--r-- | docs/CodingStandards.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/CodingStandards.rst b/docs/CodingStandards.rst index 4d66ad7574..9418680edc 100644 --- a/docs/CodingStandards.rst +++ b/docs/CodingStandards.rst @@ -796,7 +796,9 @@ In general, names should be in camel case (e.g. ``TextFileReader`` and As an exception, classes that mimic STL classes can have member names in STL's style of lower-case words separated by underscores (e.g. ``begin()``, -``push_back()``, and ``empty()``). +``push_back()``, and ``empty()``). Classes that provide multiple +iterators should add a singular prefix to ``begin()`` and ``end()`` +(e.g. ``global_begin()`` and ``use_begin()``). Here are some examples of good and bad names: |