8000 Replace <code> with backticks in docs. Addresses #255 (#486) · bazel-contrib/rules_python@6202ed2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6202ed2

Browse files
author
Jonathon Belotti
authored
Replace <code> with backticks in docs. Addresses #255 (#486)
1 parent f1b6b74 commit 6202ed2

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

‎docs/packaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ py_wheel(
9797
| extra_requires | List of optional requirements for this package | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> List of strings</a> | optional | {} |
9898
| homepage | A string specifying the URL for the package homepage. | String | optional | "" |
9999
| license | A string specifying the license of the package. | String | optional | "" |
100-
| platform | Supported platform. Use 'any' for pure-Python wheel.<br><br>If you have included platform-specific data, such as a .pyd or .so extension module, you will need to specify the platform in standard pip format. If you support multiple platforms, you can define platform constraints, then use a select() to specify the appropriate specifier, eg:<br><br>&lt;code&gt; platform = select({ "//platforms:windows_x86_64": "win_amd64", "//platforms:macos_x86_64": "macosx_10_7_x86_64", "//platforms:linux_x86_64": "manylinux2014_x86_64", }) &lt;/code&gt; | String | optional | "any" |
100+
| platform | Supported platform. Use 'any' for pure-Python wheel.<br><br>If you have included platform-specific data, such as a .pyd or .so extension module, you will need to specify the platform in standard pip format. If you support multiple platforms, you can define platform constraints, then use a select() to specify the appropriate specifier, eg:<br><br><code> platform = select({ "//platforms:windows_x86_64": "win_amd64", "//platforms:macos_x86_64": "macosx_10_7_x86_64", "//platforms:linux_x86_64": "manylinux2014_x86_64", }) </code> | String | optional | "any" |
101101
| python_requires | A string specifying what other distributions need to be installed when this one is. See the section on [Declaring required dependency](https://setuptools.readthedocs.io/en/latest/userguide/dependency_management.html#declaring-dependencies) for details and examples of the format of this argument. | String | optional | "" |
102102
| python_tag | Supported Python version(s), eg <code>py3</code>, <code>cp35.cp36</code>, etc | String | optional | "py3" |
103103
| requires | List of requirements for this package | List of strings | optional | [] |

‎docs/whl.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ This rule defines `@foo//:pkg` as a `py_library` target.
3232
| Name | Description | Type | Mandatory | Default |
3333
| :-------------: | :-------------: | :-------------: | :-------------: | :-------------: |
3434
| name | A unique name for this repository. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
35-
| extras | A subset of the "extras" available from this &lt;code&gt;.whl&lt;/code&gt; for which &lt;code&gt;requirements&lt;/code&gt; has the dependencies. | List of strings | optional | [] |
35+
| extras | A subset of the "extras" available from this <code>.whl</code> for which <code>requirements</code> has the dependencies. | List of strings | optional | [] |
3636
| python_interpreter | The command to run the Python interpreter used when unpacking the wheel. | String | optional | "python" |
37-
| requirements | The name of the &lt;code&gt;pip_import&lt;/code&gt; repository rule from which to load this &lt;code&gt;.whl&lt;/code&gt;'s dependencies. | String | optional | "" |
38-
| whl | The path to the &lt;code&gt;.whl&lt;/code&gt; file. The name is expected to follow [this convention](https://www.python.org/dev/peps/pep-0427/#file-name-convention)). | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | |
37+
| requirements | The name of the <code>pip_import</code> repository rule from which to load this <code>.whl</code>'s dependencies. | String | optional | "" |
38+
| whl | 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)). | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | |
3939

4040

‎python/packaging.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,13 +216,13 @@ pip format. If you support multiple platforms, you can define
216216
platform constraints, then use a select() to specify the appropriate
217217
specifier, eg:
218218
219-
<code>
219+
`
220220
platform = select({
221221
"//platforms:windows_x86_64": "win_amd64",
222222
"//platforms:macos_x86_64": "macosx_10_7_x86_64",
223223
"//platforms:linux_x86_64": "manylinux2014_x86_64",
224224
})
225-
</code>
225+
`
226226
""",
227227
),
228228
"python_tag": attr.string(

‎python/whl.bzl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,21 @@ def _whl_impl(repository_ctx):
3838
whl_library = repository_rule(
3939
attrs = {
4040
"extras": attr.string_list(doc = """
41-
A subset of the "extras" available from this <code>.whl</code> for which
42-
<code>requirements</code> has the dependencies.
41+
A subset of the "extras" available from this `.whl` for which
42+
`requirements` has the dependencies.
4343
"""),
4444
"python_interpreter": attr.string(default = "python", doc = """
4545
The command to run the Python interpreter used when unpacking the wheel.
4646
"""),
4747
"requirements": attr.string(doc = """
48-
The name of the <code>pip_import</code> repository rule from which to load this
49-
<code>.whl</code>'s dependencies.
48+
The name of the `pip_import` repository rule from which to load this
49+
`.whl`'s dependencies.
5050
"""),
5151
"whl": attr.label(
5252
mandatory = True,
5353
allow_single_file = True,
5454
doc = """
55-
The path to the <code>.whl</code> file. The name is expected to follow [this
55+
The path to the `.whl` file. The name is expected to follow [this
5656
convention](https://www.python.org/dev/peps/pep-0427/#file-name-convention)).
5757
""",
5858
),

0 commit comments

Comments
 (0)
0