diff options
author | Lang Hames <lhames@gmail.com> | 2016-10-25 22:41:54 +0000 |
---|---|---|
committer | Lang Hames <lhames@gmail.com> | 2016-10-25 22:41:54 +0000 |
commit | 781a2b464bece8f9b79236b9c5243f7beef6898a (patch) | |
tree | 1060c6f94652dbdeabda84570e61caa66c294297 /docs/ProgrammersManual.rst | |
parent | 41965a8963d5ae0a5ae2b0af22b1839fc3a6ec50 (diff) |
[docs] Use consistent style for "do more stuff" in Error docs examples.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@285138 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/ProgrammersManual.rst')
-rw-r--r-- | docs/ProgrammersManual.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/ProgrammersManual.rst b/docs/ProgrammersManual.rst index c1081f199bb..954872e5917 100644 --- a/docs/ProgrammersManual.rst +++ b/docs/ProgrammersManual.rst @@ -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) |