From 0b07b8ccb115bef60fe19e73dfc1b10b4f0e6370 Mon Sep 17 00:00:00 2001
From: Ben Clifford <benc@hawaga.org.uk>
Date: Mon, 13 Jan 2025 13:38:23 +0000
Subject: [PATCH] Fix a handful of Task Vine docstring issues (#3736)

## Type of change

- Update to human readable text: Documentation/error messages/comments
---
 docs/reference.rst                         | 12 ++++++++++++
 parsl/executors/taskvine/factory_config.py |  2 +-
 parsl/executors/taskvine/manager_config.py |  4 ++--
 3 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/docs/reference.rst b/docs/reference.rst
index d4c70dd7bd..3bba8acba9 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -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
 
@@ -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
diff --git a/parsl/executors/taskvine/factory_config.py b/parsl/executors/taskvine/factory_config.py
index 145e2c05d5..f198e87438 100644
--- a/parsl/executors/taskvine/factory_config.py
+++ b/parsl/executors/taskvine/factory_config.py
@@ -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
diff --git a/parsl/executors/taskvine/manager_config.py b/parsl/executors/taskvine/manager_config.py
index 0ef112fda4..26b1e460b1 100644
--- a/parsl/executors/taskvine/manager_config.py
+++ b/parsl/executors/taskvine/manager_config.py
@@ -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
@@ -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.