Use @Example annotations instead of @Examples #8224
Conversation
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
sovdeeth
requested changes
Oct 6, 2025
src/main/java/org/skriptlang/skript/bukkit/displays/text/EffTextDisplayDropShadow.java
Outdated
Show resolved
Hide resolved
applies code suggestions from @sovdeeth Co-authored-by: sovdee <[email protected]>
sovdeeth
requested changes
Oct 19, 2025
src/main/java/ch/njol/skript/conditions/CondIsSkriptCommand.java
Outdated
Show resolved
Hide resolved
src/main/java/ch/njol/skript/conditions/CondIsSkriptCommand.java
Outdated
Show resolved
Hide resolved
…o Example this changes the rest of the vanilla Skript syntaxes. the old Examples annotation is left there because addons probably use it still
bluelhf
force-pushed
the
dev/examples-migration
branch
from
96dcf0f to
332d649
Compare
thanks, sovde ! Co-authored-by: sovdee <[email protected]>
sovdeeth
requested changes
Oct 19, 2025
src/main/java/ch/njol/skript/conditions/CondElytraBoostConsume.java
Outdated
Show resolved
Hide resolved
src/main/java/ch/njol/skript/effects/EffToggleCanPickUpItems.java
Outdated
Show resolved
Hide resolved
sovdeeth
requested changes
Oct 19, 2025
src/main/java/ch/njol/skript/expressions/ExprDomestication.java
Outdated
Show resolved
Hide resolved
src/main/java/ch/njol/skript/expressions/ExprEntitySnapshot.java
Outdated
Show resolved
Hide resolved
skriptlang-automation
bot
added
the
needs reviews
applies changes from code review Co-authored-by: sovde <[email protected]>
sovdeeth
requested changes
Oct 19, 2025
src/main/java/ch/njol/skript/hooks/regions/expressions/ExprMembersOfRegion.java
Outdated
Show resolved
Hide resolved
Co-authored-by: sovde <[email protected]>
sovdeeth
approved these changes
Oct 19, 2025
sovdeeth
added
enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Previously at #8222, closed because PR was ahead base.
This PR moves many syntaxes to use
@Example-annotations instead of@Examples. The goal of this PR is to move all Skript syntaxes towards the new repeatable annotations. This results in cleaner generated JSON, with unambiguous data when multiple examples are present.Warning
This pull request was, due to its scale and simplicity, made in large part using agentic Copilot. Copilot has proven to be quite bad at tasks like programming and understanding language, and mistakes are expected.
Testing Completed
I have generated the docs and looked for errors as well as verified every example by hand.
Note about line endings
End-of-line characters are not present when examples are defined in a single line. We should consider adapting
JSONGeneratorto insert an end-of-line character at the end of each example if it is missing. This way, all examples consist of POSIX-compliant 'lines', which always end in an end-of-line character.State of pull request
@Examplesmigrated