8000 docs: fix most broken xrefs in changelog (#2902) · nedwill/rules_python@459e1df · GitHub
[go: up one dir, main page]

Skip to content

Commit 459e1df

Browse files
authored
docs: fix most broken xrefs in changelog (bazel-contrib#2902)
The changelog has a variety of broken xrefs. This fixes most of them.
1 parent 2e96b3f commit 459e1df

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

CHANGELOG.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ END_UNRELEASED_TEMPLATE
6666
* (rules) On Windows, {obj}`--bootstrap_impl=system_python` is forced. This
6767
allows setting `--bootstrap_impl=script` in bazelrc for mixed-platform
6868
environments.
69-
* (rules) {obj}`pip_compile` now generates a `.test` target. The `_test` target is deprecated
70-
and will be removed in the next major release.
69+
* (rules) {obj}`compile_pip_requirements` now generates a `.test` target. The
70+
`_test` target is deprecated and will be removed in the next major release.
7171
([#2794](https://github.com/bazel-contrib/rules_python/issues/2794)
7272
* (py_wheel) py_wheel always creates zip64-capable wheel zips
7373

@@ -190,7 +190,7 @@ END_UNRELEASED_TEMPLATE
190190
packages through SimpleAPI unless they are pulled through direct URL
191191
references. Fixes [#2023](https://github.com/bazel-contrib/rules_python/issues/2023).
192192
In case you see issues with `rules_python` being too eager to fetch the SimpleAPI
193-
metadata, you can use the newly added {attr}`pip.parse.experimental_skip_sources`
193+
metadata, you can use the newly added {attr}`pip.parse.simpleapi_skip`
194194
to skip metadata fetching for those packages.
195195
* (uv) A {obj}`lock` rule that is the replacement for the
196196
{obj}`compile_pip_requirements`. This may still have rough corners
@@ -251,7 +251,7 @@ END_UNRELEASED_TEMPLATE
251251

252252
{#v1-3-0-added}
253253
### Added
254-
* (python) {attr}`python.defaults` has been added to allow users to
254+
* (python) {obj}`python.defaults` has been added to allow users to
255255
set the default python version in the root module by reading the
256256
default version number from a file or an environment variable.
257257
* {obj}`//python/bin:python`: convenience target for directly running an
@@ -271,7 +271,7 @@ END_UNRELEASED_TEMPLATE
271271
and py_library rules
272272
([#1647](https://github.com/bazel-contrib/rules_python/issues/1647))
273273
* (rules) Added env-var to allow additional interpreter args for stage1 bootstrap.
274-
See {obj}`RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS` environment variable.
274+
See {any}`RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS` environment variable.
275275
Only applicable for {obj}`--bootstrap_impl=script`.
276276
* (rules) Added {obj}`interpreter_args` attribute to `py_binary` and `py_test`,
277277
which allows pass arguments to the interpreter before the regular args.
@@ -377,7 +377,7 @@ END_UNRELEASED_TEMPLATE
377377
values. Fixes [#2466](https://github.com/bazel-contrib/rules_python/issues/2466).
378378
* (py_proto_library) Fix import paths in Bazel 8.
379379
* (whl_library) Now the changes to the dependencies are correctly tracked when
380-
PyPI packages used in {bzl:obj}`whl_library` during the `repository_rule` phase
380+
PyPI packages used in `whl_library` during the repository rule phase
381381
change. Fixes [#2468](https://github.com/bazel-contrib/rules_python/issues/2468).
382382
+ (gazelle) Gazelle no longer ignores `setup.py` files by default. To restore
383383
this behavior, apply the `# gazelle:python_ignore_files setup.py` directive.
@@ -396,7 +396,7 @@ END_UNRELEASED_TEMPLATE
396396
* (pypi) Freethreaded packages are now fully supported in the
397397
{obj}`experimental_index_url` usage or the regular `pip.parse` usage.
398398
To select the free-threaded interpreter in the repo phase, please use
399-
the documented [env](/environment-variables.html) variables.
399+
the documented [env](environment-variables) variables.
400400
Fixes [#2386](https://github.com/bazel-contrib/rules_python/issues/2386).
401401
* (toolchains) Use the latest astrahl-sh toolchain release [20241206] for Python versions:
402402
* 3.9.21
@@ -490,7 +490,7 @@ Other changes:
490490
for the latest toolchain versions for each minor Python version. You can control
491491
the toolchain selection by using the
492492
{bzl:obj}`//python/config_settings:py_linux_libc` build flag.
493-
* (providers) Added {obj}`py_runtime_info.site_init_template` and
493+
* (providers) Added {obj}`PyRuntimeInfo.site_init_template` and
494494
{obj}`PyRuntimeInfo.site_init_template` for specifying the template to use to
495495
initialize the interpreter via venv startup hooks.
496496
* (runfiles) (Bazel 7.4+) Added support for spaces and newlines in runfiles paths
@@ -688,8 +688,8 @@ 10000 Other changes:
688688
* (bzlmod) The default value for the {obj}`--python_version` flag will now be
689689
always set to the default python toolchain version value.
690690
* (bzlmod) correctly wire the {attr}`pip.parse.extra_pip_args` all the
691-
way to {obj}`whl_library`. What is more we will pass the `extra_pip_args` to
692-
{obj}`whl_library` for `sdist` distributions when using
691+
way to `whl_library`. What is more we will pass the `extra_pip_args` to
692+
`whl_library` for `sdist` distributions when using
693693
{attr}`pip.parse.experimental_index_url`. See
694694
[#2239](https://github.com/bazel-contrib/rules_python/issues/2239).
695695
* (whl_filegroup): Provide per default also the `RECORD` file
@@ -737,8 +737,8 @@ Other changes:
737737

738738
{#v0-37-0-removed}
739739
### Removed
740-
* (precompiling) {obj}`--precompile_add_to_runfiles` has been removed.
741-
* (precompiling) {obj}`--pyc_collection` has been removed. The `pyc_collection`
740+
* (precompiling) `--precompile_add_to_runfiles` has been removed.
741+
* (precompiling) `--pyc_collection` has been removed. The `pyc_collection`
742742
attribute now bases its default on {obj}`--precompile`.
743743
* (precompiling) The {obj}`precompile=if_generated_source` value has been removed.
744744
* (precompiling) The {obj}`precompile_source_retention=omit_if_generated_source` value has been removed.
@@ -790,7 +790,7 @@ Other changes:
790790
in extra_requires in py_wheel rule.
791791
* (rules) Prevent pytest from trying run the generated stage2
792792
bootstrap .py file when using {obj}`--bootstrap_impl=script`
793-
* (toolchain) The {bzl:obj}`gen_python_config_settings` has been fixed to include
793+
* (toolchain) The `gen_python_config_settings` has been fixed to include
794794
the flag_values from the platform definitions.
795795

796796
{#v0-36-0-added}
@@ -1205,9 +1205,9 @@ Other changes:
12051205
depend on legacy labels instead of the hub repo aliases and you use the
12061206
`experimental_requirement_cycles`, now is a good time to migrate.
12071207

1208-
[python_default_visibility]: gazelle/README.md#directive-python_default_visibility
1208+
[python_default_visibility]: https://github.com/bazel-contrib/rules_python/tree/main/gazelle/README.md#directive-python_default_visibility
12091209
[test_file_pattern_issue]: https://github.com/bazel-contrib/rules_python/issues/1816
1210-
[test_file_pattern_docs]: gazelle/README.md#directive-python_test_file_pattern
1210+
[test_file_pattern_docs]: https://github.com/bazel-contrib/rules_python/tree/main/gazelle/README.md#directive-python_test_file_pattern
12111211
[20240224]: https://github.com/indygreg/python-build-standalone/releases/tag/20240224.
12121212
[20240415]: https://github.com/indygreg/python-build-standalone/releases/tag/20240415.
12131213

0 commit comments

Comments
 (0)
0