[llvm] r280460 - [Docs] Fix a couple of typos in the Error/Expected docs.

Lang Hames via llvm-commits llvm-commits at lists.llvm.org
Thu Sep 1 20:46:08 PDT 2016


Author: lhames
Date: Thu Sep  1 22:46:08 2016
New Revision: 280460

URL: http://llvm.org/viewvc/llvm-project?rev=280460&view=rev
Log:
[Docs] Fix a couple of typos in the Error/Expected docs.

Modified:
    llvm/trunk/docs/ProgrammersManual.rst

Modified: llvm/trunk/docs/ProgrammersManual.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/ProgrammersManual.rst?rev=280460&r1=280459&r2=280460&view=diff
==============================================================================
--- llvm/trunk/docs/ProgrammersManual.rst (original)
+++ llvm/trunk/docs/ProgrammersManual.rst Thu Sep  1 22:46:08 2016
@@ -320,7 +320,7 @@ actually a lightweight wrapper for user-
 information to be attached to describe the error. This is similar to the way C++
 exceptions allow throwing of user-defined types.
 
-Success values are created by calling ``Error::success()``:
+Success values are created by calling ``Error::success()``, E.g.:
 
 .. code-block:: c++
 
@@ -334,7 +334,7 @@ Success values are very cheap to constru
 impact on program performance.
 
 Failure values are constructed using ``make_error<T>``, where ``T`` is any class
-that inherits from the ErrorInfo utility:
+that inherits from the ErrorInfo utility, E.g.:
 
 .. code-block:: c++
 
@@ -374,7 +374,7 @@ success, enabling the following idiom:
 
 For functions that can fail but need to return a value the ``Expected<T>``
 utility can be used. Values of this type can be constructed with either a
-``T``, or a ``Error``. Expected<T> values are also implicitly convertible to
+``T``, or an ``Error``. Expected<T> values are also implicitly convertible to
 boolean, but with the opposite convention to Error: true for success, false for
 error. If success, the ``T`` value can be accessed via the dereference operator.
 If failure, the ``Error`` value can be extracted using the ``takeError()``
@@ -384,7 +384,7 @@ method. Idiomatic usage looks like:
 
   Expected<float> parseAndSquareRoot(IStream &IS) {
     float f;
-    OS >> f;
+    IS >> f;
     if (f < 0)
       return make_error<FloatingPointError>(...);
     return sqrt(f);




More information about the llvm-commits mailing list