Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
yashmehrotra committed Aug 14, 2016
1 parent 5a86811 commit 0bbcb7f
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/api_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,29 @@ API Documentation

The class object which is returned with the *soldier.run()* method.

**methods**
**Methods**

.. function:: kill()
.. function:: kill()

This function is used to kill the current process
This function is used to kill the current process

:rtype: None
:rtype: *None*


.. function:: is_alive()
.. function:: is_alive()

This function checks whether process is active or not
This function checks whether process is active or not

:rtype: A *boolean*
:rtype: *boolean*


**properties**
**Properties**

- pid - Returns the pid of the process
- status_code - Returns the status code of the process
- output - Returns the stdout (standard output) of the process
- error - Returns the stderr (standard error) of the process
- start_ts - Returns the start time (:class:`datetime.datetime` object) of the process
- end_ts - Returns the end time (:class:`datetime.datetime` object) of the process
- duration - Returns the total duration(:class:`datetime.timedelta object) of the process
- duration - Returns the total duration(:class:`datetime.timedelta` object) of the process

0 comments on commit 0bbcb7f

Please sign in to comment.