From f4c2104d00c47d65b216b7a63fa41f4be934bf5b Mon Sep 17 00:00:00 2001 From: Rafael Espindola Date: Wed, 7 Aug 2013 19:34:37 +0000 Subject: [PATCH] Add the common begin/end naming convention to the coding standard. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@187902 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CodingStandards.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/CodingStandards.rst b/docs/CodingStandards.rst index 4d66ad75743..9418680edc7 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: -- 2.34.1