Add the common begin/end naming convention to the coding standard.
authorRafael Espindola <rafael.espindola@gmail.com>
Wed, 7 Aug 2013 19:34:37 +0000 (19:34 +0000)
committerRafael Espindola <rafael.espindola@gmail.com>
Wed, 7 Aug 2013 19:34:37 +0000 (19:34 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@187902 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CodingStandards.rst

index 4d66ad75743541f3baeaa2cdd6bef251517c61c5..9418680edc74a14a9cc39423b37eb70ade0051ea 100644 (file)
@@ -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()``,
   
 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:
 
 
 Here are some examples of good and bad names: