Remove passive voice in python, release job RST 02/62302/1
authorLott, Christopher (cl778h) <cl778h@att.com>
Sat, 16 Nov 2019 11:28:28 +0000 (06:28 -0500)
committerLott, Christopher (cl778h) <cl778h@att.com>
Sat, 16 Nov 2019 11:28:28 +0000 (06:28 -0500)
Change-Id: Ie20a255c670a87a6e95e2c3c5c11bcf6b2c91097
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
docs/jjb/lf-python-jobs.rst
docs/jjb/lf-release-jobs.rst

index 3b14264..ca309d6 100644 (file)
@@ -361,13 +361,13 @@ pyenv variables before running.
    export PYENV_ROOT="/opt/pyenv"
    export PATH="$PYENV_ROOT/bin:$PATH"
 
-Installable package projects should consider using a directory layout
-like the one shown below. All Python files are below a directory, and
-the package source files are nested in a subdirectory. This layout
-allows straightforward build-job triggers using the directory paths so
-Jenkins jobs are triggered appropriately. For example, a PyPI merge
-job should not be triggered by a non-Python change, because the job
-cannot upload the same package twice.
+Installable package projects should use the directory layout shown
+below. All Python files are in a repo subdirectory separate from
+non-Python files like documentation. This layout allows highly
+specific build-job triggers in Jenkins using the subdirectory
+paths. For example, a PyPI merge job should not run on a non-Python
+file change such as documentation, because the job cannot upload the
+same package twice.
 
 .. code-block:: bash
 
index e124f8c..77b46d1 100644 (file)
@@ -208,7 +208,7 @@ packages.
         release repositories, for example "mypackage".
     :python_version: The Python interpreter version to use for pip
         "Requires-Python" compatibility checks, for example '3', '3.7' or 3.7.4.
-        Valid decimal values such as 3 and 3.7 must be quoted.
+        Put valid decimal values such as 3 or 3.7 in quotes to pass schema validation.
     :version: The semantic version string used for the package in the
         setup.py file.