Skip to content

Commit

Permalink
gh-1305 small fixes in popen.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Onvember committed Jun 26, 2020
1 parent 29c20a6 commit 018ef04
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions doc/reference/reference_lua/popen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,17 @@ Below is a list of all ``popen`` functions and handle methods.
:ref:`popen.new() <popen-new>` or
:ref:`popen.shell() <popen-shell>`
:param table opts: options

Possible errors, raised on incorrect parameters or when the fiber is cancelled:

* IllegalParams: incorrect type or value of a parameter
* IllegalParams: called on a closed handle
* IllegalParams: opts.stdout and opts.stderr are both set
* IllegalParams: a requested IO operation is not supported by
the handle (stdout / stderr is not piped)
* IllegalParams: attempt to operate on a closed file descriptor
* FiberIsCancelled: cancelled by an outside code

:return: true on success, false on error
:rtype: (if success) string with read value, empty string if EOF

Expand All @@ -409,15 +420,7 @@ Below is a list of all ``popen`` functions and handle methods.
stderr if one sets ``opts.stderr`` to ``true`` (it is not legal to set both
``opts.stdout`` and ``opts.stderr`` to ``true``).

Possible raised errors are:

* IllegalParams: incorrect type or value of a parameter
* IllegalParams: called on a closed handle
* IllegalParams: opts.stdout and opts.stderr are both set
* IllegalParams: a requested IO operation is not supported by
the handle (stdout / stderr is not piped)
* IllegalParams: attempt to operate on a closed file descriptor
* FiberIsCancelled: cancelled by an outside code

Possible error reasons when ``nil, err`` is returned are:

Expand Down

0 comments on commit 018ef04

Please sign in to comment.