Skip to content

(documentation) clarify that upper range does not include patch versions #1877

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

(documentation) clarify that upper range does not include patch versions #1877

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
2 changes: 1 addition & 1 deletion docs/source/basic_concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ of each attribute):
env.PYTHONPATH.append("{root}/python")
env.PATH.append("{root}/bin")

The :attr:`requires` section defines the requirements of the package. The :func:`commands` section describes
The :attr:`requires` section defines the requirements of the package, excluding *any* subsequent patch versions. The :func:`commands` section describes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso Jan 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this could be added to the "Package Requests" section. And in theory it's already covered by the foo-1.2+<2 example, isn't it?

Copy link
Contributor

@herronelou herronelou Mar 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to go back and look at the issue (#1824) to understand what this was talking about.

Maybe instead it might be worth it to add an example with the <= operator as in the issue, as I can see how it could be ambiguous, and is not listed in https://rez.readthedocs.io/en/stable/basic_concepts.html#package-requests

what happens when this package is added to an environment. Here, the ``bin`` directory in the package
installation is appended to ``PATH``, and similarly the ``python`` subdirectory is appended to
``PYTHONPATH``.
Expand Down