Skip to content

Commit

Permalink
better doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
opalmer committed Nov 1, 2015
1 parent 27c5746 commit c4f403a
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions pyfarm/jobtypes/core/jobtype.py
Original file line number Diff line number Diff line change
Expand Up @@ -566,8 +566,19 @@ def get_environment(self):

def get_command_list(self, commands):
"""
Return a list of command to be used when running the process
as a read-only tuple.
Convert a list of commands to a tuple with any environment variables
expanded.
:param list commands:
A list of strings to expand. Each entry in list will be passed
into and returned from :meth:`expandvars`.
:raises TypeError:
Raised of ``commands`` is not a list or tuple.
:rtype: tuple
:return:
Returns the expanded list of commands.
"""
self._check_command_list_inputs(commands)
return tuple(map(self.expandvars, commands))
Expand Down

0 comments on commit c4f403a

Please sign in to comment.