Skip to content

Commit

Permalink
fix some docstring formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mmckerns committed Feb 20, 2023
1 parent 02d0755 commit 8539f89
Show file tree
Hide file tree
Showing 7 changed files with 96 additions and 110 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {'https://docs.python.org/3/': None}
# {'python': {'https://docs.python.org/': None},
# 'mystic': {'https://mystic.readthedocs.io/en/latest/', None},
# 'pyina': {'https://pyina.readthedocs.io/en/latest/', None},
Expand Down
18 changes: 9 additions & 9 deletions pathos/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def copy(source, destination=None, **kwds):
Execute a copy, and return the copier. Use 'kill' to kill the copier, and
'pid' to get the process id for the copier.
Inputs:
Args:
source -- path string of source 'file'
destination -- path string for destination target
'''
Expand Down Expand Up @@ -55,7 +55,7 @@ def execute(command, host=None, bg=True, **kwds):
response from the executed command. Use 'kill' to kill the launcher, and 'pid'
to get the process id for the launcher.
Inputs:
Args:
command -- command string to be executed
host -- hostname of execution target [default = None (i.e. run locally)]
bg -- run as background process? [default = True]
Expand Down Expand Up @@ -84,7 +84,7 @@ def execute(command, host=None, bg=True, **kwds):
def kill(pid, host=None, **kwds):
'''kill a process (possibly) on a remote host
Inputs:
Args:
pid -- process id
host -- hostname where process is running [default = None (i.e. locally)]
'''
Expand Down Expand Up @@ -121,7 +121,7 @@ def getpid(target=None, host=None, all=False, **kwds):
If target is None, then get the process id of the __main__ python instance.
Inputs:
Args:
target -- string name of target process
host -- hostname where process is running
all -- get all resulting lines from query? [default = False]
Expand Down Expand Up @@ -170,7 +170,7 @@ def getppid(pid=None, host=None, group=False): # find parent of pid
If pid is None, the pid of the __main__ python instance will be used.
Inputs:
Args:
pid -- process id
host -- hostname where process is running
group -- get parent group id (pgid) instead of direct parent id?
Expand Down Expand Up @@ -207,7 +207,7 @@ def getchild(pid=None, host=None, group=False): # find all children of pid
If pid is None, the pid of the __main__ python instance will be used.
Inputs:
Args:
pid -- parent process id
host -- hostname where process is running
group -- get process ids for the parent group id (pgid) instead?
Expand Down Expand Up @@ -245,7 +245,7 @@ def getchild(pid=None, host=None, group=False): # find all children of pid
def randomport(host=None):
'''select a open port on a (possibly) remote host
Inputs:
Args:
host -- hostname on which to select a open port
'''
from pathos.portpicker import randomport
Expand All @@ -271,7 +271,7 @@ def randomport(host=None):
def connect(host, port=None, through=None):
'''establish a secure tunnel connection to a remote host at the given port
Inputs:
Args:
host -- hostname to which a tunnel should be established
port -- port number (on host) to connect the tunnel to
through -- 'tunnel-through' hostname [default = None]
Expand All @@ -286,7 +286,7 @@ def connect(host, port=None, through=None):
def serve(server, host=None, port=None, profile='.bash_profile'):
'''begin serving RPC requests
Inputs:
Args:
server: name of RPC server (i.e. 'ppserver')
host: hostname on which a server should be launched
port: port number (on host) that server will accept request at
Expand Down
4 changes: 2 additions & 2 deletions pathos/hosts.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
For example, to register two 'known' host profiles:
_profiles = { \
'foobar.danse.us':'.profile',
'computer.cacr.caltech.edu':'.cshrc',
'foobar.danse.us':'.profile', \
'computer.cacr.caltech.edu':'.cshrc', \
}
"""

Expand Down

0 comments on commit 8539f89

Please sign in to comment.