Skip to content

Commit edd5b1e

Browse files
authored
docs(pipstar): add more docs to make it ready for release (#3323)
Followup to #3225 to add more documentation.
1 parent 83cea77 commit edd5b1e

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ END_UNRELEASED_TEMPLATE
8181
With this release we are deprecating {obj}`pip.parse.experimental_target_platforms` and
8282
{obj}`pip_repository.experimental_target_platforms`. For users using `WORKSPACE` and
8383
vendoring the `requirements.bzl` file, please re-vendor so that downstream is unaffected
84-
when the APIs get removed.
84+
when the APIs get removed. If you need to customize the way the dependencies get
85+
evaluated, see [our docs](/pypi/download.html#customizing-requires-dist-resolution) on customizing `Requires-Dist` resolution.
8586

8687
{#v0-0-0-fixed}
8788
### Fixed

docs/environment-variables.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ instead of the legacy Python scripts.
7171

7272
:::{versionadded} 1.5.0
7373
:::
74+
:::{versionchanged} VERSION_NEXT_FEATURE
75+
Flipped to be enabled by default.
76+
:::
7477
::::
7578

7679
::::{envvar} RULES_PYTHON_EXTRACT_ROOT

docs/pypi/download.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,11 +168,6 @@ available on the PyPI index that you use.
168168

169169
### Customizing `Requires-Dist` resolution
170170

171-
:::{note}
172-
Currently this is disabled by default, but you can turn it on using
173-
{envvar}`RULES_PYTHON_ENABLE_PIPSTAR` environment variable.
174-
:::
175-
176171
In order to understand what dependencies to pull for a particular package,
177172
`rules_python` parses the `whl` file [`METADATA`][metadata].
178173
Packages can express dependencies via `Requires-Dist`, and they can add conditions using

0 commit comments

Comments
 (0)