]> granicus.if.org Git - llvm/commitdiff
[docs] Use consistent style for "do more stuff" in Error docs examples.
authorLang Hames <lhames@gmail.com>
Tue, 25 Oct 2016 22:41:54 +0000 (22:41 +0000)
committerLang Hames <lhames@gmail.com>
Tue, 25 Oct 2016 22:41:54 +0000 (22:41 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@285138 91177308-0d34-0410-b5e6-96231b3b80d8

docs/ProgrammersManual.rst

index c1081f199bb6aedd9c0f69efede919433f46a15b..954872e5917317feddb535750fd4eac8b6906ef9 100644 (file)
@@ -398,7 +398,7 @@ operator. If failure, the ``Error`` value can be extracted using the
     if (auto FileOrErr = openFormattedFile(Path)) {
       // On success, grab a reference to the file and continue.
       auto &File = *FileOrErr;
-      // ...
+      ...
     } else
       // On error, extract the Error value and return it.
       return FileOrErr.takeError();
@@ -418,7 +418,7 @@ rewritten as:
       return Err;
     // On success, grab a reference to the file and continue.
     auto &File = *FileOrErr;
-    // ...
+    ...
   }
 
 This second form is often more readable for functions that involve multiple
@@ -695,7 +695,8 @@ type inspection method, ``isA``, and the ``consumeError`` function:
           return Err;
       }
       auto &Child = *ChildOrErr;
-      // do work
+      // Use Child
+      ...
     }
     return Error::success();
   }
@@ -719,7 +720,8 @@ completing the walk over the archive they could use the ``joinErrors`` utility:
         else
           return Err;
       auto &Child = *ChildOrErr;
-      // do work
+      // Use Child
+      ...
     }
     return DeferredErrs;
   }
@@ -751,7 +753,8 @@ class) the result is much cleaner iteration idiom:
 
   Error Err;
   for (auto &Child : Ar->children(Err)) {
-    // Use Child - we only enter the loop when it’s valid.
+    // Use Child - we only enter the loop when it’s valid
+    ...
   }
   // Check Err after the loop to ensure it didn’t break due to an error.
   if (Err)