Fix docstrings, reorder attr, run buildifier, regen docs and tools

brandjon · brandjon · commit dfab65619786 · 2019-11-06T19:25:15.000-05:00
diff --git a/docs/pip.md b/docs/pip.md
@@ -5,7 +5,7 @@
 ## pip_import
 
 <pre>
-pip_import(<a href="#pip_import-name">name</a>, <a href="#pip_import-requirements">requirements</a>)
+pip_import(<a href="#pip_import-name">name</a>, <a href="#pip_import-python_interpreter">python_interpreter</a>, <a href="#pip_import-requirements">requirements</a>)
 </pre>
 
 A rule for importing `requirements.txt` dependencies into Bazel.
@@ -67,6 +67,16 @@ py_binary(
         </p>
       </td>
     </tr>
+    <tr id="pip_import-python_interpreter">
+      <td><code>python_interpreter</code></td>
+      <td>
+        String; optional
+        <p>
+          The command to run the Python interpreter used to invoke pip and unpack the
+wheels.
+        </p>
+      </td>
+    </tr>
     <tr id="pip_import-requirements">
       <td><code>requirements</code></td>
       <td>
diff --git a/docs/whl.md b/docs/whl.md
@@ -5,7 +5,7 @@
 ## whl_library
 
 <pre>
-whl_library(<a href="#whl_library-name">name</a>, <a href="#whl_library-extras">extras</a>, <a href="#whl_library-requirements">requirements</a>, <a href="#whl_library-whl">whl</a>)
+whl_library(<a href="#whl_library-name">name</a>, <a href="#whl_library-extras">extras</a>, <a href="#whl_library-python_interpreter">python_interpreter</a>, <a href="#whl_library-requirements">requirements</a>, <a href="#whl_library-whl">whl</a>)
 </pre>
 
 A rule for importing `.whl` dependencies into Bazel.
@@ -53,6 +53,15 @@ This rule defines `@foo//:pkg` as a `py_library` target.
         </p>
       </td>
     </tr>
+    <tr id="whl_library-python_interpreter">
+      <td><code>python_interpreter</code></td>
+      <td>
+        String; optional
+        <p>
+          The command to run the Python interpreter used when unpacking the wheel.
+        </p>
+      </td>
+    </tr>
     <tr id="whl_library-requirements">
       <td><code>requirements</code></td>
       <td>
diff --git a/packaging/piptool.py b/packaging/piptool.py
@@ -87,7 +87,8 @@ def pip_main(argv):
     description='Import Python dependencies into Bazel.')
 
 parser.add_argument('--python_interpreter', action='store',
-                    help=('The python python interpreter to use '))
+                    help=('The Python interpreter to use when extracting '
+                          'wheels.'))
 
 parser.add_argument('--name', action='store',
                     help=('The namespace of the import.'))
diff --git a/python/pip.bzl b/python/pip.bzl
@@ -43,15 +43,15 @@ def _pip_import_impl(repository_ctx):
 
 pip_import = repository_rule(
     attrs = {
-        "python_interpreter": attr.string(default="python", doc="""
-The command to run the Python interpreter used to invoke pip and unpack the
-wheels.
-"""),
         "requirements": attr.label(
             mandatory = True,
             allow_single_file = True,
             doc = "The label of the requirements.txt file.",
         ),
+        "python_interpreter": attr.string(default = "python", doc = """
+The command to run the Python interpreter used to invoke pip and unpack the
+wheels.
+"""),
         "_script": attr.label(
             executable = True,
             default = Label("//tools:piptool.par"),
diff --git a/python/whl.bzl b/python/whl.bzl
@@ -44,9 +44,6 @@ A subset of the "extras" available from this <code>.whl</code> for which
         "requirements": attr.string(doc = """
 The name of the <code>pip_import</code> repository rule from which to load this
 <code>.whl</code>'s dependencies.
-"""),
-        "python_interpreter": attr.string(default="python", doc="""
-The command to run the Python interpreter used when unpacking the wheel.
 """),
         "whl": attr.label(
             mandatory = True,
@@ -56,6 +53,9 @@ The path to the <code>.whl</code> file. The name is expected to follow [this
 convention](https://www.python.org/dev/peps/pep-0427/#file-name-convention)).
 """,
         ),
+        "python_interpreter": attr.string(default = "python", doc = """
+The command to run the Python interpreter used when unpacking the wheel.
+"""),
         "_script": attr.label(
             executable = True,
             default = Label("//tools:whltool.par"),
diff --git a/tools/piptool.par b/tools/piptool.par
