Skip to content

Commit

Permalink
Improve Executable constructor doc (#4983)
Browse files Browse the repository at this point in the history
* Trying to improve Executable constructor doc

* Attempte to improve documentation for 2 boolean variables

* Typo
  • Loading branch information
pannarale authored Dec 19, 2024
1 parent 242620a commit bf2fc30
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions pycbc/workflow/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,8 @@ def __init__(self, cp, name, ifos=None, out_dir=None, tags=None,
-----------
cp : ConfigParser object
The ConfigParser object holding the workflow configuration settings
exec_name : string
name : string
Executable name
universe : string, optional
Condor universe to run the job in
ifos : string or list, optional
The ifo(s) that the Job is valid for. If the job is
independently valid for multiple ifos it can be provided as a list.
Expand All @@ -135,6 +133,16 @@ def __init__(self, cp, name, ifos=None, out_dir=None, tags=None,
The folder to store output files of this job.
tags : list of strings
A list of strings that is used to identify this job.
reuse_executable: boolean [default True]
If True, Pegasus simply uses the name of the (executable) script
to label the Executable instance, otherwise it also includes tags
in the labeling and, e.g., performance information is recorded
individually by job rather than being grouped together on the
basis of the script name.
set_submit_subdir: boolean [default True]
Place condor files associated with this executable under a
sub-directory (named according to the executable name) in the
submitdir.
"""
if isinstance(ifos, str):
self.ifo_list = [ifos]
Expand Down

0 comments on commit bf2fc30

Please sign in to comment.