Merge branch 'master' into cottsay/shell-tests

Author: cottsay

colcon_core/environment/__init__.py

@@ -76,7 +76,7 @@ def create_environment_scripts(
     :param pkg: The package descriptor
     :param args: The parsed command line arguments
     :param list default_hooks: If none are parsed explicitly the hooks provided
-      by :function:`create_environment_hooks` are used
+      by :func:`create_environment_hooks` are used
     :param list additional_hooks: Any additional hooks which should be
       referenced by the generated scripts
     :returns: iterable of generated file paths
@@ -101,7 +101,7 @@ def create_environment_scripts_only(
     :param prefix_path: The prefix path
     :param pkg: The package descriptor
     :param list default_hooks: If none are parsed explicitly the hooks provided
-      by :function:`create_environment_hooks` are used
+      by :func:`create_environment_hooks` are used
     :param list additional_hooks: Any additional hooks which should be
       referenced by the generated scripts
     :returns: iterable of generated script paths

colcon_core/event_reactor.py

@@ -42,7 +42,7 @@ def _run(self):
         """
         Process events and notify all observers.
 
-        If no events are being process for :py:attribute:`TIMER_INTERVAL`
+        If no events are being process for :attr:`TIMER_INTERVAL`
         seconds a :class:`TimerEvent` is being generated and processed.
 
         An :class:`EventReactorShutdown` event will stop the loop.

colcon_core/executor/__init__.py

@@ -182,6 +182,7 @@ def execute(
         :param arguments: The passed arguments
 
         The deprecated API accepts the following separate arguments:
+
         :param args: The parsed command line arguments
         :param jobs: The jobs
         :param on_error: The decision how to proceed when one job fails
@@ -279,14 +280,14 @@ def execute_jobs(
     Execute jobs.
 
     The overview of the process:
-    * One executor extension is being chosen based on the command line
-      arguments.
-    * Create an event controller.
-    * Pass the event controller to the executor extension.
-    * Pass the event queue to all jobs.
-    * Start the event controller.
-    * Invoke the executor extension to execute the jobs.
-    * Join the event controller.
+      * One executor extension is being chosen based on the command line
+        arguments.
+      * Create an event controller.
+      * Pass the event controller to the executor extension.
+      * Pass the event queue to all jobs.
+      * Start the event controller.
+      * Invoke the executor extension to execute the jobs.
+      * Join the event controller.
 
     :param jobs: The ordered dictionary of jobs
     :param on_error: The decision how to proceed when one job fails

colcon_core/location.py

@@ -18,7 +18,7 @@ def get_config_path():
     """
     Get the base path for configuration files.
 
-    :function:`set_default_config_path` must have been called before.
+    :func:`set_default_config_path` must have been called before.
 
     :returns: The base path for configuration files
     :rtype: Path
@@ -72,7 +72,7 @@ def get_log_path():
     """
     Get the base path for logging.
 
-    :function:`set_default_log_path` must have been called before.
+    :func:`set_default_log_path` must have been called before.
 
     :returns: The base path for logging or None if logging is disabled
     :rtype: Path or None
@@ -147,7 +147,7 @@ def create_log_path(verb_name):
     """
     Create a not yet existing logging directory.
 
-    The logging directory returned by :function:`get_log_path` must not yet
+    The logging directory returned by :func:`get_log_path` must not yet
     exist on the first call of this function.
     If it does exist the function will append a serial number to the path until
     the path doesn't exist and can be created.

colcon_core/output_style/__init__.py

@@ -118,8 +118,7 @@ def add_output_style_arguments(parser, *, extensions=None):
 
     :param parser: The argument parser
     :param extensions: The output style extensions to use, if `None` is passed
-      use the extensions provided by
-      :function:`get_output_style_extensions`
+      use the extensions provided by :func:`get_output_style_extensions`
     """
     if extensions is None:
         extensions = get_output_style_extensions()
@@ -160,8 +159,7 @@ def select_output_style_extension(args, *, extensions=None):
 
     :param args: The parsed command line arguments
     :param extensions: The output style extensions to use, if `None` is passed
-      use the extensions provided by
-      :function:`get_output_style_extensions`
+      use the extensions provided by :func:`get_output_style_extensions`
 
     :returns: The output style extension (or None if not available)
     """
@@ -180,8 +178,7 @@ def apply_output_style(args, *, extensions=None):
 
     :param args: The parsed command line arguments
     :param extensions: The output style extensions to use, if `None` is passed
-      use the extensions provided by
-      :function:`get_output_style_extensions`
+      use the extensions provided by :func:`get_output_style_extensions`
     """
     # TODO: This approach chooses only a single extension. Should it be
     #       possible to apply styles on top of each other, possibly ones which

colcon_core/package_augmentation/__init__.py

@@ -126,7 +126,7 @@ def update_descriptor(
 
     Any key-value pair not explicitly mentioned above is being used to update
     the metadata if the key is in the list of additional argument names.
-    See :function:`update_metadata` for details how the metadata is updated.
+    See :func:`update_metadata` for details how the metadata is updated.
 
     If the additional argument names is a list with the single value `*` all
     keys not explicitly mentioned above are being used to update the metadata.

colcon_core/package_discovery/__init__.py

@@ -109,7 +109,7 @@ def add_package_discovery_arguments(parser, *, extensions=None):
     :param parser: The argument parser
     :param extensions: The package discovery extensions to use, if `None` is
       passed use the extensions provided by
-      :function:`get_package_discovery_extensions`
+      :func:`get_package_discovery_extensions`
     """
     if extensions is None:
         extensions = get_package_discovery_extensions()
@@ -165,10 +165,10 @@ def discover_packages(
     :param args: The parsed command line arguments
     :param identification_extensions: The package identification extensions to
       pass to each invocation of
-      :function:`PackageDiscoveryExtensionPoint.discover`
+      :func:`PackageDiscoveryExtensionPoint.discover`
     :param discovery_extensions: The package discovery extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_discovery_extensions`
+      :func:`get_package_discovery_extensions`
     :returns: set of
       :py:class:`colcon_core.package_descriptor.PackageDescriptor`
     :rtype: set

colcon_core/package_identification/__init__.py

@@ -21,7 +21,7 @@ class IgnoreLocationException(Exception):
     This also excludes all recursive subdirectories from being considered.
 
     It should be raised in the
-    :function:`PackageIdentificationExtensionPoint.identify` method of package
+    :func:`PackageIdentificationExtensionPoint.identify` method of package
     identification extensions.
     """
 

colcon_core/package_selection/__init__.py

@@ -77,16 +77,16 @@ def add_arguments(
     """
     Add the command line arguments for the package selection extensions.
 
-    The function will call :function:`add_package_discovery_arguments` to add
+    The function will call :func:`add_package_discovery_arguments` to add
     the package discovery arguments.
 
     :param parser: The argument parser
     :param discovery_extensions: The package discovery extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_discovery_extensions`
+      :func:`get_package_discovery_extensions`
     :param selection_extensions: The package selection extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_selection_extensions`
+      :func:`get_package_selection_extensions`
     """
     add_package_discovery_arguments(parser, extensions=discovery_extensions)
 
@@ -142,9 +142,9 @@ def get_packages(
     Get the selected package decorators in topological order.
 
     The overview of the process:
-    * Get the package descriptors
-    * Order them topologically
-    * Select the packages based on the command line arguments
+      * Get the package descriptors
+      * Order them topologically
+      * Select the packages based on the command line arguments
 
     :param additional_argument_names: A list of additional arguments to
       consider
@@ -154,16 +154,16 @@ def get_packages(
       immediate upstream category which included the dependency
     :param discovery_extensions: The package discovery extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_discovery_extensions`
+      :func:`get_package_discovery_extensions`
     :param identification_extensions: The package identification extensions to
       use, if `None` is passed use the extensions provided by
-      :function:`get_package_identification_extensions`
+      :func:`get_package_identification_extensions`
     :param augmentation_extensions: The package augmentation extensions, if
       `None` is passed use the extensions provided by
-      :function:`get_package_augmentation_extensions`
+      :func:`get_package_augmentation_extensions`
     :param selection_extensions: The package selection extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_selection_extensions`
+      :func:`get_package_selection_extensions`
     :rtype: list
     :raises RuntimeError: if the returned set of packages contains duplicates
       package names
@@ -207,25 +207,25 @@ def get_package_descriptors(
     Get the package descriptors.
 
     The overview of the process:
-    * Discover the package descriptors using the package discovery and
-      identification extensions
-    * Check is the passed package selection arguments have valid values
-    * Augment the package descriptors
+      * Discover the package descriptors using the package discovery and
+        identification extensions
+      * Check is the passed package selection arguments have valid values
+      * Augment the package descriptors
 
     :param additional_argument_names: A list of additional arguments to
       consider
     :param discovery_extensions: The package discovery extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_discovery_extensions`
+      :func:`get_package_discovery_extensions`
     :param identification_extensions: The package identification extensions to
       use, if `None` is passed use the extensions provided by
-      :function:`get_package_identification_extensions`
+      :func:`get_package_identification_extensions`
     :param augmentation_extensions: The package augmentation extensions, if
       `None` is passed use the extensions provided by
-      :function:`get_package_augmentation_extensions`
+      :func:`get_package_augmentation_extensions`
     :param selection_extensions: The package selection extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_selection_extensions`
+      :func:`get_package_selection_extensions`
     :returns: set of
       :py:class:`colcon_core.package_descriptor.PackageDescriptor`
     :rtype: set
@@ -276,7 +276,7 @@ def select_package_decorators(
     :param list decorators: The package decorators in topological order
     :param selection_extensions: The package selection extensions to use, if
       `None` is passed use the extensions provided by
-      :function:`get_package_selection_extensions`
+      :func:`get_package_selection_extensions`
     """
     # filtering must happen after the topological ordering since otherwise
     # packages in the middle of the dependency graph might be missing

colcon_core/shell/__init__.py

@@ -259,7 +259,7 @@ async def generate_command_environment(
 
         The method must be overridden in a subclass if and only if the shell
         extension represents a "primary" shell (as defined in
-        :attribute:`ShellExtensionPoint.PRIORITY`).
+        :attr:`ShellExtensionPoint.PRIORITY`).
 
         :param str task_name: The name of the task
         :param Path build_base: The base path of the build directory