Skip to content

Commit

Permalink
Fix a handful of Task Vine docstring issues (#3736)
Browse files Browse the repository at this point in the history
## Type of change

- Update to human readable text: Documentation/error messages/comments
  • Loading branch information
benclifford authored Jan 13, 2025
1 parent 5aac648 commit 0b07b8c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
12 changes: 12 additions & 0 deletions docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Configuration
parsl.addresses.address_by_interface
parsl.addresses.address_by_query
parsl.addresses.address_by_route
parsl.addresses.get_all_addresses
parsl.addresses.get_any_address
parsl.utils.get_all_checkpoints
parsl.utils.get_last_checkpoint

Expand Down Expand Up @@ -193,3 +195,13 @@ Internal
parsl.jobs.job_status_poller.JobStatusPoller
parsl.jobs.strategy.Strategy
parsl.utils.Timer

Task Vine configuration
=======================

.. autosummary::
:toctree: stubs
:nosignatures:

parsl.executors.taskvine.TaskVineManagerConfig
parsl.executors.taskvine.TaskVineFactoryConfig
2 changes: 1 addition & 1 deletion parsl/executors/taskvine/factory_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class TaskVineFactoryConfig:
worker_options: Optional[str]
Additional options to pass to workers. Run
`vine_worker --help` for more details.
``vine_worker --help`` for more details.
Default is None.
worker_executable: str
Expand Down
4 changes: 2 additions & 2 deletions parsl/executors/taskvine/manager_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class TaskVineManagerConfig:
address: Optional[str]
Address of the local machine.
If None, socket.gethostname() will be used to determine the address.
If None, :py:func:`parsl.addresses.get_any_address` will be used to determine the address.
project_name: Optional[str]
If given, TaskVine will periodically report its status and performance
Expand Down Expand Up @@ -56,7 +56,7 @@ class TaskVineManagerConfig:
environment name is given, TaskVine will package the conda
environment in a tarball and send it along with tasks to be
executed in a replicated conda environment.
If a tarball of packages (*.tar.gz) is given, TaskVine
If a tarball of packages (``*.tar.gz``) is given, TaskVine
skips the packaging step and sends the tarball along with
tasks to be executed in a replicated conda environment.
Expand Down

0 comments on commit 0b07b8c

Please sign in to comment.