8000 docs: fix xrefs in by rickeylev · Pull Request #2917 · bazel-contrib/rules_python · GitHub
[go: up one dir, main page]
Skip to content

docs: fix xrefs in #2917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025
Merged

docs: fix xrefs in #2917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion python/private/attr_builders.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1222,7 +1222,7 @@ def _StringList_typedef():
:::

:::{field} default
:type: Value[list[str] | configuration_field]
:type: list[str] | configuration_field
:::

:::{function} doc() -> str
Expand All @@ -1237,6 +1237,9 @@ def _StringList_typedef():
:::{function} set_allow_empty(v: bool)
:::

:::{function} set_default(v: list[str] | configuration_field)
:::

:::{function} set_doc(v: str)
:::

Expand Down
14 changes: 7 additions & 7 deletions python/private/py_console_script_binary.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,18 @@ def py_console_script_binary(
"""Generate a py_binary for a console_script entry_point.

Args:
name: [`target-name`] The name of the resulting target.
pkg: {any}`simple label` the package for which to generate the script.
entry_points_txt: optional [`label`], the entry_points.txt file to parse
name: {type}`Name` The name of the resulting target.
pkg: {type}`Label` the package for which to generate the script.
entry_points_txt: {type}`label | None`, the entry_points.txt file to parse
for available console_script values. It may be a single file, or a
group of files, but must contain a file named `entry_points.txt`.
If not specified, defaults to the `dist_info` target in the same
package as the `pkg` Label.
script: [`str`], The console script name that the py_binary is going to be
script: {type}`str`, The console script name that the py_binary is going to be
generated for. Defaults to the normalized name attribute.
binary_rule: {any}`rule callable`, The rule/macro to use to instantiate
the target. It's expected to behave like {any}`py_binary`.
Defaults to {any}`py_binary`.
binary_rule: {type}`callable`, The rule/macro to use to instantiate
the target. It's expected to behave like {obj}`py_binary`.
Defaults to {obj}`py_binary`.
**kwargs: Extra parameters forwarded to `binary_rule`.
"""
main = "rules_python_entry_point_{}.py".format(name)
Expand Down
2 changes: 1 addition & 1 deletion python/private/pypi/attrs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ If True, suppress printing stdout and stderr output to the terminal.
If you would like to get more diagnostic output, set
{envvar}`RULES_PYTHON_REPO_DEBUG=1 <RULES_PYTHON_REPO_DEBUG>`
or
{envvar}`RULES_PYTHON_REPO_DEBUG_VERBOSITY=<INFO|DEBUG|TRACE> <RULES_PYTHON_REPO_DEBUG_VERBOSITY>`
{envvar}`RULES_PYTHON_REPO_DEBUG_VERBOSITY=INFO|DEBUG|TRACE <RULES_PYTHON_REPO_DEBUG_VERBOSITY>`
""",
),
# 600 is documented as default here: https://docs.bazel.build/versions/master/skylark/lib/repository_ctx.html#execute
Expand Down
0