Skip to content

Commit ba07d49

Browse files
authored
Various typo/doc clarifications
1 parent b0feaf2 commit ba07d49

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

BZLMOD_SUPPORT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ platforms.
4545
If you want to use the same toolchain as what WORKSPACE used, then manually
4646
register the builtin Bazel Python toolchain by doing
4747
`register_toolchains("@bazel_tools//tools/python:autodetecting_toolchain")`.
48+
49+
Note that using this builtin Bazel toolchain is deprecated and unsupported.
50+
See the {obj}`runtime_env_toolchains` docs for a replacement that is marginally
51+
better supported.
4852
**IMPORTANT: this should only be done in a root module, and may interfere with
4953
the toolchains rules_python registers**.
5054

docs/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The core Python rules -- `py_library`, `py_binary`, `py_test`,
88
`py_proto_library`, and related symbols that provide the basis for Python
99
support in Bazel.
1010

11-
When using bazel 6 (or earlier), the core rules are bundled into the Bazel binary, and the symbols
12-
in this repository are simple aliases. On bazel 7 and above `rules_python` uses
11+
When using Bazel 6 (or earlier), the core rules are bundled into the Bazel binary, and the symbols
12+
in this repository are simple aliases. On Bazel 7 and above `rules_python` uses
1313
a separate Starlark implementation,
1414
see {ref}`Migrating from the Bundled Rules` below.
1515

@@ -32,11 +32,12 @@ releases. In that case, please raise a GH issue.
3232

3333
:::{topic} Sphinxdocs
3434

35-
`sphinxdocs` rules allow users to generate documentation from bazel or
36-
Python source code.
35+
`sphinxdocs` rules allow users to generate documentation using Sphinx powered by Bazel, with additional functionality for documenting
36+
Starlark and Bazel code.
3737

38-
This is available as is and the semantic versioning used by `rules_python` does
39-
not apply.
38+
The functionality is exposed because other projects find it useful, but
39+
it is available as is and **the semantic versioning and
40+
compatibility policy used by `rules_python` does not apply**.
4041

4142
:::
4243

0 commit comments

Comments
 (0)