Skip to content

Commit f36d120

Browse files
authored
docs: fix xrefs in (#2917)
More misc xrefs fixes in: * attr_builders * py_console_script_binary * pypi envvar ref
1 parent a746b8f commit f36d120

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

python/private/attr_builders.bzl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1222,7 +1222,7 @@ def _StringList_typedef():
12221222
:::
12231223
12241224
:::{field} default
1225-
:type: Value[list[str] | configuration_field]
1225+
:type: list[str] | configuration_field
12261226
:::
12271227
12281228
:::{function} doc() -> str
@@ -1237,6 +1237,9 @@ def _StringList_typedef():
12371237
:::{function} set_allow_empty(v: bool)
12381238
:::
12391239
1240+
:::{function} set_default(v: list[str] | configuration_field)
1241+
:::
1242+
12401243
:::{function} set_doc(v: str)
12411244
:::
12421245

python/private/py_console_script_binary.bzl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,18 @@ def py_console_script_binary(
5656
"""Generate a py_binary for a console_script entry_point.
5757
5858
Args:
59-
name: [`target-name`] The name of the resulting target.
60-
pkg: {any}`simple label` the package for which to generate the script.
61-
entry_points_txt: optional [`label`], the entry_points.txt file to parse
59+
name: {type}`Name` The name of the resulting target.
60+
pkg: {type}`Label` the package for which to generate the script.
61+
entry_points_txt: {type}`label | None`, the entry_points.txt file to parse
6262
for available console_script values. It may be a single file, or a
6363
group of files, but must contain a file named `entry_points.txt`.
6464
If not specified, defaults to the `dist_info` target in the same
6565
package as the `pkg` Label.
66-
script: [`str`], The console script name that the py_binary is going to be
66+
script: {type}`str`, The console script name that the py_binary is going to be
6767
generated for. Defaults to the normalized name attribute.
68-
binary_rule: {any}`rule callable`, The rule/macro to use to instantiate
69-
the target. It's expected to behave like {any}`py_binary`.
70-
Defaults to {any}`py_binary`.
68+
binary_rule: {type}`callable`, The rule/macro to use to instantiate
69+
the target. It's expected to behave like {obj}`py_binary`.
70+
Defaults to {obj}`py_binary`.
7171
**kwargs: Extra parameters forwarded to `binary_rule`.
7272
"""
7373
main = "rules_python_entry_point_{}.py".format(name)

python/private/pypi/attrs.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ If True, suppress printing stdout and stderr output to the terminal.
210210
If you would like to get more diagnostic output, set
211211
{envvar}`RULES_PYTHON_REPO_DEBUG=1 <RULES_PYTHON_REPO_DEBUG>`
212212
or
213-
{envvar}`RULES_PYTHON_REPO_DEBUG_VERBOSITY=<INFO|DEBUG|TRACE> <RULES_PYTHON_REPO_DEBUG_VERBOSITY>`
213+
{envvar}`RULES_PYTHON_REPO_DEBUG_VERBOSITY=INFO|DEBUG|TRACE <RULES_PYTHON_REPO_DEBUG_VERBOSITY>`
214214
""",
215215
),
216216
# 600 is documented as default here: https://docs.bazel.build/versions/master/skylark/lib/repository_ctx.html#execute

0 commit comments

Comments
 (0)