Skip to content

Commit 6288d80

Browse files
committed
Update docstrings for job methods
1 parent 2c0bc63 commit 6288d80

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

pyslurm/pyslurm.pyx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1961,12 +1961,11 @@ cdef class job:
19611961
def find_id(self, jobid):
19621962
u"""Retrieve job ID data.
19631963
1964-
This method calls slurm_xlate_job_id() to convert a jobid string to a
1965-
jobid int. For example, a subjob of 123_4 would translate to 124.
1966-
Then, slurm_load_job() gets all job_table records associated with that
1967-
specific job. This works for single jobs and job arrays.
1964+
This method accepts both string and integer formats of the jobid. It
1965+
calls slurm_xlate_job_id() to convert the jobid appropriately.
1966+
This works for single jobs and job arrays.
19681967
1969-
:param str jobID: Job id key string to search
1968+
:param str jobid: Job id key string to search
19701969
:returns: List of dictionary of values for given job id
19711970
:rtype: `list`
19721971
"""
@@ -2514,6 +2513,10 @@ cdef class job:
25142513
def slurm_job_batch_script(self, jobid):
25152514
"""
25162515
Retrieve the batch script for a given jobid.
2516+
2517+
:param str jobid: Job id key string to search
2518+
:returns: String output of a jobid's batch script
2519+
:rtype: `str`
25172520
"""
25182521
if isinstance(jobid, int) or isinstance(jobid, long):
25192522
jobid = str(jobid).encode("UTF-8")

0 commit comments

Comments
 (0)