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

docs: fix some more bad xrefs #2910

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 2 commits into from
May 19, 2025
Merged

docs: fix some more bad xrefs #2910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cee9df1
docs: fix some more bad xrefs
rickeylev May 18, 2025
99c3216
fix buildifier warning
rickeylev May 19, 2025
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
9 changes: 5 additions & 4 deletions python/private/python_register_toolchains.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def python_register_toolchains(

With `bzlmod` enabled, this function is not needed since `rules_python` is
handling everything. In order to override the default behaviour from the
root module one can see the docs for the {rule}`python` extension.
root module one can see the docs for the {obj}`python` extension.

- Create a repository for each built-in platform like "python_3_8_linux_amd64" -
this repository is lazily fetched when Python is needed for that platform.
Expand All @@ -71,9 +71,10 @@ def python_register_toolchains(
tool_versions: {type}`dict` contains a mapping of version with SHASUM
and platform info. If not supplied, the defaults in
python/versions.bzl will be used.
platforms: {type}`dict[str, platform_info]` platforms to create toolchain
repositories for. Note that only a subset is created, depending
on what's available in `tool_versions`.
platforms: {type}`dict[str, struct]` platforms to create toolchain
repositories for. Keys are platform names, and values are platform_info
structs. Note that only a subset is created, depending on what's
available in `tool_versions`.
minor_mapping: {type}`dict[str, str]` contains a mapping from `X.Y` to `X.Y.Z`
version.
**kwargs: passed to each {obj}`python_repository` call.
Expand Down
18 changes: 15 additions & 3 deletions python/private/rule_builders.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ ExecGroup = struct(
)

def _ToolchainType_typedef():
"""Builder for {obj}`config_common.toolchain_type()`
"""Builder for {obj}`config_common.toolchain_type`

:::{include} /_includes/field_kwargs_doc.md
:::
Expand Down Expand Up @@ -393,7 +393,7 @@ def _RuleCfg_update_inputs(self, *others):

Args:
self: implicitly added
*others: {type}`collection[Label]` collection of labels to add to
*others: {type}`list[Label]` collection of labels to add to
inputs. Only values not already present are added. Note that a
`Label`, not `str`, should be passed to ensure different apparent
labels can be properly de-duplicated.
Expand All @@ -405,7 +405,7 @@ def _RuleCfg_update_outputs(self, *others):

Args:
self: implicitly added
*others: {type}`collection[Label]` collection of labels to add to
*others: {type}`list[Label]` collection of labels to add to
outputs. Only values not already present are added. Note that a
`Label`, not `str`, should be passed to ensure different apparent
labels can be properly de-duplicated.
Expand Down Expand Up @@ -680,6 +680,18 @@ def _AttrsDict_build(self):
attrs[k] = v.build() if _is_builder(v) else v
return attrs

def _AttributeBuilder_typedef():
"""An abstract base typedef for builder for a Bazel {obj}`Attribute`

Instances of this are a builder for a particular `Attribute` type,
e.g. `attr.label`, `attr.string`, etc.
"""

# buildifier: disable=name-conventions
AttributeBuilder = struct(
TYPEDEF = _AttributeBuilder_typedef,
)

# buildifier: disable=name-conventions
AttrsDict = struct(
TYPEDEF = _AttrsDict_typedef,
Expand Down
2 changes: 1 addition & 1 deletion python/uv/private/uv.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ uv.configure(
"urls": attr.string_list(
doc = """\
The urls to download the binary from. If this is used, {attr}`base_url` and
{attr}`manifest_name` are ignored for the given version.
{attr}`manifest_filename` are ignored for the given version.

::::note
If the `urls` are specified, they need to be specified for all of the platforms
Expand Down
0