(documentation) clarify that upper range does not include patch versions#1877
Conversation
include patch versions Signed-off-by: sarah-kamall <sarah.zaky02@eng-st.cu.edu.eg>
JeanChristopheMorinPerso
left a comment
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.
| 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?
There was a problem hiding this comment.
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
Closes #1824