-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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
8.4-RC1: Release notes: Confusing sample of the configuration api #26504
Labels
a:documentation
Documentation content
in:dependency-declarations
variant notation attributes capability substitution
re:comprehensibility
reasonable errors and warnings, clear dsl, mental overload
Milestone
Comments
jbartok
added
in:dependency-declarations
variant notation attributes capability substitution
and removed
to-triage
labels
Sep 25, 2023
Thank you for your interest in Gradle! This is a valid documentation issue that we will address. We should add an in-line comment on the declarations that match the default, to clary that they match the default: |
tresat
added
the
re:comprehensibility
reasonable errors and warnings, clear dsl, mental overload
label
Sep 25, 2023
jvandort
added a commit
that referenced
this issue
Sep 26, 2023
The existing release notes had some problems. Fixes #26504
jvandort
added a commit
that referenced
this issue
Sep 26, 2023
The existing release notes had some problems. Fixes #26504
bot-gradle
added a commit
that referenced
this issue
Sep 26, 2023
…e notes The existing release notes had some problems. Fixes #26504 Co-authored-by: Justin Van Dort <jvandort@gradle.com>
This was referenced Oct 17, 2023
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
re:comprehensibility
reasonable errors and warnings, clear dsl, mental overload
Issue type
Wrong or misleading information
Problem description
The sample of the old configuration api only sets the non-default properties to false. This code is correct, but confusing due the similar property names. Instead, also add the default value to highlight the new improved api:
Also, please, change the order of the new usage and use the same names:
Context (optional)
I was unable to create a PR because I don't know where the release notes are stored, the master branch contains the new release notes of 8.5
Page with the problem
https://docs.gradle.org/8.4-rc-1/release-notes.html
The text was updated successfully, but these errors were encountered: