Skip to content
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.

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

Version ranges use sometimes wrong brackets #31536

Closed
pdolezal opened this issue Dec 5, 2024 · 3 comments · Fixed by #31772
Closed

Version ranges use sometimes wrong brackets #31536

pdolezal opened this issue Dec 5, 2024 · 3 comments · Fixed by #31772
Assignees
Labels
a:documentation Documentation content in:dependency-declarations variant notation attributes capability substitution
Milestone

Comments

@pdolezal
Copy link

pdolezal commented Dec 5, 2024

Issue type

Wrong or misleading information

Problem description

It seems that version ranges in the documentation are not correctly formatted (or what had happened). For instance, see the page about them: from that point down the version ranges have often a wrong right bracket – [ instead of ) or ]. I think I saw that on other pages too.

As a Gradle newbie, I was somewhat confused first and I thought it was some Gradle idiosyncrasy 😅

Context (optional)

No response

Page with the problem

https://docs.gradle.org/current/userguide/dependency_versions.html#sec:rich-version-constraints

@pdolezal pdolezal added a:documentation Documentation content to-triage labels Dec 5, 2024
@lkasso lkasso self-assigned this Dec 6, 2024
@lkasso lkasso removed the to-triage label Dec 6, 2024
@lkasso
Copy link
Member

lkasso commented Dec 6, 2024

Hey @pdolezal, please note that:

  • [ and ] indicate an inclusive bound -> [1.1, 2.0]
  • ( and ) indicate an exclusive bound -> (1.1, 2.0) or (1.2, 1.5] or [1.1, 2.0)
  • ] can be used instead of ( for an exclusive lower bound -> ]1.2, 1.5] instead of (1.2, 1.5]
  • [ can be used instead of ) for exclusive upper bound -> [1.1, 2.0[ instead of [1.1, 2.0)

Would you like me to add this to that doc page? Is there anything else that doesn't make sense?

@lkasso lkasso added in:dependency-declarations variant notation attributes capability substitution and removed to-triage labels Dec 6, 2024
@lkasso lkasso added this to the 8.12 RC1 milestone Dec 6, 2024
@pdolezal
Copy link
Author

pdolezal commented Dec 6, 2024

@lkasso Hi, thanks for the reply. Well, the possibility that it stands for an exclusive bound came to my mind, because it was repeated multiple times, but I could not find any explicit explanation. If it is missing indeed, I'd vote for adding it ✌ Specifically, I would expect it in the section Understanding version declarations.

@lkasso
Copy link
Member

lkasso commented Dec 9, 2024

I will go ahead and add it this week. I will make sure it gets released in Gradle 8.12

@lkasso lkasso modified the milestones: 8.12 RC1, 8.13 RC1 Dec 9, 2024
lkasso added a commit that referenced this issue Dec 16, 2024
@lkasso lkasso modified the milestones: 8.13 RC1, 8.12 RC2 Dec 16, 2024
@lkasso lkasso linked a pull request Dec 16, 2024 that will close this issue
@ljacomet ljacomet modified the milestones: 8.12 RC2, 8.12 Dec 17, 2024
@lkasso lkasso closed this as completed Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:documentation Documentation content in:dependency-declarations variant notation attributes capability substitution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants