(documentation) clarify that upper range does not include patch versions #1877
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
include patch versions Signed-off-by: sarah-kamall <[email protected]>
There was a problem hiding this comment.
Hi @sarah-kamall, thanks for contributing this change. I took a closer look at the docs and it feels like this is already covered in the docs. In foo-1.2+<2, we document how the requests work and we have an example for foo-1.2+<2 that explicitly says foo-1.2 or greater, but less than 2 and gives some examples like foo-1.2.0, foo-1.6.4, foo-1.99.
I'll leave this open in case you want to maybe make the example clearer or rework that section of the doc.
| @@ -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 | |||
There was a problem hiding this comment.
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?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1824