aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDeterminant <ted.sybil@gmail.com>2018-02-11 19:28:09 -0500
committerDeterminant <ted.sybil@gmail.com>2018-02-11 19:28:09 -0500
commit3ac928b90e7dd3f11f92490edac283c6e2bc6fda (patch)
tree93a6753afa56774c9b8ecac2cfaabd7979b99bdd /README.rst
parent9da19de63af8876e8cfaed4abe5a9a6f957986a7 (diff)
add rejection example
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 76591e6..c1d9088 100644
--- a/README.rst
+++ b/README.rst
@@ -48,7 +48,7 @@ argument.
promise_t::resolve() const;
-Resolve the promise without empty result. This may trigger the other promises
+Resolve the promise with empty result. This may trigger the other promises
waiting for the current promise recursively. When a promise is triggered, the
registered ``on_fulfilled()`` function should be expecting no argument,
otherwise a type mismatch is thrown.
@@ -57,7 +57,7 @@ otherwise a type mismatch is thrown.
promise_t::reject() const;
-Reject the promise without empty reason. This may reject the other promises
+Reject the promise with empty reason. This may reject the other promises
waiting for the current promise recursively. When a promise is rejected, the
registered ``on_rejected()`` function should be expecting on argument,
otherwise a type mismatch is thrown.
@@ -93,7 +93,7 @@ the current promise.
.. code-block:: cpp
- template<typename PList> promise_t promise::all(PList promise_list);
+ template<typename PList> promise_t promise::all(const PList &promise_list);
Create a promise waiting for the asynchronous resolution of all promises in
``promise_list``. The result for the created promise will be typed
@@ -104,7 +104,7 @@ promises.
.. code-block:: cpp
- template<typename PList> promise_t promise::race(PList promise_list);
+ template<typename PList> promise_t promise::race(const PList &promise_list);
Create a promise waiting for the asynchronous resolution of any promises in
``promise_list``. The result for the created promise will be the result from