Experiment descriptions #8105
Open
Experiment descriptions #8105
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
Efnilite
added
the
enhancement
skriptlang-automation
bot
added
the
needs reviews
Burbulinis
approved these changes
Aug 1, 2025
sovdeeth
requested changes
Aug 1, 2025
skriptlang-automation
bot
removed
the
needs reviews
…to feature/feature-descriptions
Pesekjak
approved these changes
Aug 2, 2025
sovdeeth
requested changes
Aug 20, 2025
sovdeeth
requested changes
Aug 21, 2025
sovdeeth
requested changes
Aug 21, 2025
src/main/java/org/skriptlang/skript/lang/experiment/Experiment.java
Outdated
Show resolved
Hide resolved
sovdeeth
approved these changes
Aug 21, 2025
skriptlang-automation
bot
added
the
feature-ready
github-project-automation
bot
moved this from In Review
to Awaiting Merge
in 2.13 Releases
APickledWalrus
requested changes
Aug 21, 2025
Comment on lines
+389
to
+392
| JsonArray description = new JsonArray(); | ||
| for (String part : experiment.description().split("\\n")) { | ||
| description.add(part); | ||
| } |
There was a problem hiding this comment.
This can be moved inside of the else below, right?
| CATCH_ERRORS("Runtime Error Catching", | ||
| "catch runtime errors", | ||
| """ | ||
| A new catch [run[ ]time] error[s] section allows you to catch and suppress runtime errors within it and access them later with [the] last caught [run[ ]time] errors. |
There was a problem hiding this comment.
Would remove the pattern syntax from this
| private final LifeCycle phase; | ||
| private final SkriptPattern compiledPattern; | ||
|
|
||
| Feature(String codeName, LifeCycle phase, String... patterns) { | ||
| Feature(@NotNull String displayName, @NotNull String codeName, |
There was a problem hiding this comment.
Nitpick but I feel like it makes more sense to have codeName first
| /** | ||
| * @return The description for this experiment. | ||
| */ | ||
| default @NotNull String description() { |
There was a problem hiding this comment.
Should this be a list of strings? I feel like that's the standard, but would like to hear thoughts. Could keep the single string constructor and just split at newlines for simplicity too.
github-project-automation
bot
moved this from Awaiting Merge
to In Review
in 2.13 Releases
skriptlang-automation
bot
removed
the
feature-ready
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.
Problem
Currently, experiments have no standardized way of being displayed in docs sites. There's also no easily available description or display name which docs sites can use for displaying.
Solution
Adds an optional description and display name to Experiment.
Testing Completed
Manually checked.
Supporting Information
Completes: none
Related: none