GROOVY-12038: Graduate groovy-contracts from incubating to stable#2563
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2563 +/- ##
==================================================
+ Coverage 68.1890% 68.1929% +0.0040%
- Complexity 33094 33097 +3
==================================================
Files 1508 1508
Lines 126148 126148
Branches 22888 22888
==================================================
+ Hits 86019 86024 +5
+ Misses 32487 32485 -2
+ Partials 7642 7639 -3 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Graduates core groovy-contracts annotations from incubating to stable by removing @Incubating markers and updating the user guide/package docs accordingly, while also expanding the documentation and spec examples for loop termination measures via @Decreases.
Changes:
- Remove
@Incubatingfrom core contract annotations (@Requires,@Ensures,@Invariant) and their repeatable container annotations; add/clarify@sinceand Javadoc. - Update contracts user guide to document
@Contractedenablement and add a new@Decreasessection with spec-backed examples. - Refresh
groovy.contractspackage-level documentation to distinguish stable vs incubating annotations.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| subprojects/groovy-contracts/src/spec/test/ContractsTest.groovy | Adds tagged spec examples for @Decreases on while/for loops for inclusion in docs. |
| subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc | Documents @Contracted, adds @Decreases feature + section, updates feature list terminology. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/RequiresConditions.java | Removes @Incubating; improves container-annotation Javadoc and adds @since. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/Requires.java | Removes @Incubating; adds @since and keeps API stable. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/package-info.java | Reworks package Javadoc to explicitly list stable vs incubating annotations. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/Invariants.java | Removes @Incubating; improves container-annotation Javadoc and adds @since. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/Invariant.java | Removes @Incubating; adds @since and keeps API stable. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/EnsuresConditions.java | Removes @Incubating; improves container-annotation Javadoc and adds @since. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/Ensures.java | Removes @Incubating; adds @since and keeps API stable. |
| subprojects/groovy-contracts/src/main/java/groovy/contracts/Contracted.java | Adds @since to the marker annotation Javadoc. |
This comment has been minimized.
This comment has been minimized.
This file contains hidden or 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
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.
No description provided.