maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

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

llvm-svn: 280460
This commit is contained in:
Lang Hames 2016-09-02 03:46:08 +00:00
parent a10e516596
commit 42f5dd8066
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
llvm/docs/ProgrammersManual.rst
View File

@ -320,7 +320,7 @@ actually a lightweight wrapper for user-defined error types, allowing arbitrary
information to be attached to describe the error. This is similar to the way C++ information to be attached to describe the error. This is similar to the way C++
exceptions allow throwing of user-defined types. 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++ .. code-block:: c++
@ -334,7 +334,7 @@ Success values are very cheap to construct and return - they have minimal
impact on program performance. impact on program performance.
Failure values are constructed using ``make_error<T>``, where ``T`` is any class 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++ .. 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>`` 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 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 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. error. If success, the ``T`` value can be accessed via the dereference operator.
If failure, the ``Error`` value can be extracted using the ``takeError()`` 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) { Expected<float> parseAndSquareRoot(IStream &IS) {
float f; float f;
OS >> f; IS >> f;
if (f < 0) if (f < 0)
return make_error<FloatingPointError>(...); return make_error<FloatingPointError>(...);
return sqrt(f); return sqrt(f);