From: Lang Hames Date: Fri, 2 Sep 2016 03:46:08 +0000 (+0000) Subject: [Docs] Fix a couple of typos in the Error/Expected docs. X-Git-Tag: llvmorg-4.0.0-rc1~10798 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=42f5dd80666062415854789d64ef0d28bf223c5a;p=platform%2Fupstream%2Fllvm.git [Docs] Fix a couple of typos in the Error/Expected docs. llvm-svn: 280460 --- diff --git a/llvm/docs/ProgrammersManual.rst b/llvm/docs/ProgrammersManual.rst index 0306370..0ab1a4c 100644 --- a/llvm/docs/ProgrammersManual.rst +++ b/llvm/docs/ProgrammersManual.rst @@ -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++ 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 construct and return - they have minimal impact on program performance. Failure values are constructed using ``make_error``, 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`` utility can be used. Values of this type can be constructed with either a -``T``, or a ``Error``. Expected values are also implicitly convertible to +``T``, or an ``Error``. Expected 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 parseAndSquareRoot(IStream &IS) { float f; - OS >> f; + IS >> f; if (f < 0) return make_error(...); return sqrt(f);