Skip to content

Commit

Permalink
Improve documentation after previous refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
xolox committed Nov 10, 2015
1 parent 3ec4415 commit c9b60b8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@
intersphinx_mapping = dict(
python2=('http://docs.python.org', None),
python3=('http://docs.python.org/3', None),
propertymanager=('http://property-manager.readthedocs.org/en/latest', None),
humanfriendly=('https://humanfriendly.readthedocs.org/en/latest', None),
propertymanager=('https://property-manager.readthedocs.org/en/latest', None),
)

# -- Options for HTML output ---------------------------------------------------
Expand Down
10 changes: 7 additions & 3 deletions executor/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,10 @@ class ExternalCommand(ControllableProcess):
features (e.g. asynchronous command execution that preserves the ability to
provide input and capture output).
:class:`ExternalCommand` inherits from :class:`ControllableProcess` so all
of the process manipulation supported by :class:`ControllableProcess` is
also supported by :class:`ExternalCommand` objects.
Because the :class:`ExternalCommand` class has a lot of properties and
methods here is a summary:
Expand All @@ -560,9 +564,9 @@ class ExternalCommand(ControllableProcess):
and what its output is.
**Public methods**
The public methods :func:`start()`, :func:`wait()` and :func:`terminate()`
enable you to start external commands, wait for them to finish and
terminate them if they take too long.
The public methods :func:`start()`, :func:`wait()`, :func:`terminate()`
and :func:`kill()` enable you to start external commands, wait for them to
finish and terminate them if they take too long.
**Internal methods**
The internal methods :func:`check_errors()`, :func:`load_output()` and
Expand Down

0 comments on commit c9b60b8

Please sign in to comment.