Adds experimental annotation #7109
Open
Conversation
This file contains 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
- Updates the existing annotations - Updates SkriptEventInfo to include an experimental method
Efnilite
suggested changes
Sep 22, 2024
| @@ -248,7 +215,7 @@ public <R> ClassInfo<T> math(final Class<R> relativeType, final Arithmetic<? sup | |||
| /** | |||
| * Only used for Skript's documentation. | |||
| * | |||
| * @param name | |||
| * @param name The name of this ClassInfo | |||
| * @return This ClassInfo object | |||
| */ | |||
| public ClassInfo<T> name(final String name) { | |||
There was a problem hiding this comment.
Suggested change
| public ClassInfo<T> name(final String name) { | |
| public ClassInfo<T> name(String name) { |
| @@ -260,7 +227,7 @@ public ClassInfo<T> name(final String name) { | |||
| /** | |||
| * Only used for Skript's documentation. | |||
| * | |||
| * @param description | |||
| * @param description The description(s) of this ClassInfo | |||
| * @return This ClassInfo object | |||
| */ | |||
| public ClassInfo<T> description(final String... description) { | |||
There was a problem hiding this comment.
Suggested change
| public ClassInfo<T> description(final String... description) { | |
| public ClassInfo<T> description(String... description) { |
| @@ -272,7 +239,7 @@ public ClassInfo<T> description(final String... description) { | |||
| /** | |||
| * Only used for Skript's documentation. | |||
| * | |||
| * @param usage | |||
| * @param usage The usage(s) of this ClassInfo | |||
| * @return This ClassInfo object | |||
| */ | |||
| public ClassInfo<T> usage(final String... usage) { | |||
There was a problem hiding this comment.
Suggested change
| public ClassInfo<T> usage(final String... usage) { | |
| public ClassInfo<T> usage(String... usage) { |
| @@ -284,7 +251,7 @@ public ClassInfo<T> usage(final String... usage) { | |||
| /** | |||
| * Only used for Skript's documentation. | |||
| * | |||
| * @param examples | |||
| * @param examples The example(s) for this ClassInfo | |||
| * @return This ClassInfo object | |||
| */ | |||
| public ClassInfo<T> examples(final String... examples) { | |||
There was a problem hiding this comment.
Suggested change
| public ClassInfo<T> examples(final String... examples) { | |
| public ClassInfo<T> examples(String... examples) { |
| @@ -296,7 +263,7 @@ public ClassInfo<T> examples(final String... examples) { | |||
| /** | |||
| * Only used for Skript's documentation. | |||
| * | |||
| * @param since | |||
| * @param since The version of the plugin in which this ClassInfo was added | |||
| * @return This ClassInfo object | |||
| */ | |||
| public ClassInfo<T> since(final String since) { | |||
There was a problem hiding this comment.
Suggested change
| public ClassInfo<T> since(final String since) { | |
| public ClassInfo<T> since(String since) { |
| @@ -310,14 +277,34 @@ public ClassInfo<T> since(final String since) { | |||
| * | |||
| * Only used for Skript's documentation. | |||
| * | |||
| * @param pluginNames | |||
| * @param pluginNames The plugins, other than Skript, that this ClassInfo requires | |||
| * @return This ClassInfo object | |||
| */ | |||
| public ClassInfo<T> requiredPlugins(final String... pluginNames) { | |||
There was a problem hiding this comment.
Suggested change
| public ClassInfo<T> requiredPlugins(final String... pluginNames) { | |
| public ClassInfo<T> requiredPlugins(String... pluginNames) { |
| * @return This ClassInfo object | ||
| */ | ||
| public ClassInfo<T> requiredPlugins(final String... pluginNames) { | ||
| assert this.requiredPlugins == null; | ||
| this.requiredPlugins = pluginNames; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Provides information regarding the experiment which this ClassInfo requires. |
There was a problem hiding this comment.
Suggested change
| * Provides information regarding the experiment which this ClassInfo requires. | |
| * Provides information regarding the experimental feature in this ClassInfo. |
| @@ -526,8 +504,7 @@ public String toString(final int flags) { | |||
| } | |||
|
|
|||
| @Override | |||
| @NotNull | |||
| public String toString(final @Nullable Event event, final boolean debug) { | |||
| public @NotNull String toString(final @Nullable Event event, final boolean debug) { | |||
There was a problem hiding this comment.
Suggested change
| public @NotNull String toString(final @Nullable Event event, final boolean debug) { | |
| public @NotNull String toString(@Nullable Event event, boolean debug) { |
| @@ -136,6 +120,21 @@ public SkriptEventInfo<E> since(String since) { | |||
| return this; | |||
| } | |||
|
|
|||
| /** | |||
| * Only used for Skript's documentation. | |||
There was a problem hiding this comment.
missing explanation of what this is
sovdeeth
added
the
enhancement
sovdeeth
approved these changes
Sep 22, 2024
Comment on lines
+19
to
+20
| String featureName(); | ||
| LifeCycle phase(); |
There was a problem hiding this comment.
Do you think it might be better to require the actual experiment here? It seems tedious to have to update the phase whenever an experiment updates. The experiment itself can just be grabbed from the enum: https://github.com/SkriptLang/Skript/blob/ef3d3603c4aaedf519f2c1322c3a0f09f4b53a67/src/main/java/ch/njol/skript/registrations/Feature.java
There was a problem hiding this comment.
I was thinking this as well. Maybe it would be better to have the annotation be like, @Feature(String featureName, String feedbackLink), and then use smth like ExperimentRegistry#find(String name) later to get the experiment and its phase and stuff?
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.
Description
This PR adds a new experimental annotation, which can be used to provide information about an experiment on which a syntax element depends. The provided information is the experiment name, the associated life cycle, and the associated feedback line (as a string).
Also updates the existing doc annotations, and adds experimental stuff to SkriptEventInfo and ClassInfo,
Target Minecraft Versions: any
Requirements: none
Related Issues: