launchpad-reviewers team mailing list archive

[Jürgen Gmach <mp+448090@xxxxxxxxxxxxxxxxxx>]

Jürgen Gmach has proposed merging ~jugmac00/launchpad:improve-docstrings-run-parts into launchpad:master.

Commit message:
Improve docstrings in the run-parts module

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~jugmac00/launchpad/+git/launchpad/+merge/448090
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~jugmac00/launchpad:improve-docstrings-run-parts into launchpad:master.

diff --git a/doc/how-to/creating-staging-account.rst b/doc/how-to/creating-staging-account.rst
new file mode 100644
index 0000000..0188e08
--- /dev/null
+++ b/doc/how-to/creating-staging-account.rst
@@ -0,0 +1,4 @@
+========================================
+Creating a Staging Account for Launchpad
+========================================
+
diff --git a/lib/lp/archivepublisher/run_parts.py b/lib/lp/archivepublisher/run_parts.py
index 7391216..4144a32 100644
--- a/lib/lp/archivepublisher/run_parts.py
+++ b/lib/lp/archivepublisher/run_parts.py
@@ -1,7 +1,11 @@
 # Copyright 2011-2018 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
-"""Publisher support for running programs from a plug-in directory."""
+"""Publisher support for running programs from a plug-in directory.
+
+This module offers a thin wrapper around the system application `run-parts`,
+which runs scripts or programs in a given directory.
+"""
 
 __all__ = [
     "execute_subprocess",
@@ -53,7 +57,10 @@ def execute_subprocess(args, log=None, failure=None, **kwargs):
 
 
 def run_parts(distribution_name, parts, log=None, env=None):
-    """Execute run-parts.
+    """Execute the system application `run-parts`.
+
+    `run-parts` runs scripts or programs in a given directory.
+    See https://man.cx/run-parts(8).
 
     :param distribution_name: The name of the distribution to execute
         run-parts scripts for.