Documentation annotations improvements (Prototype).#7470
Merged
Conversation
Efnilite
approved these changes
Jan 19, 2025
Co-authored-by: Efnilite <35348263+Efnilite@users.noreply.github.com>
Efnilite
approved these changes
Jan 23, 2025
sovdeeth
approved these changes
Feb 7, 2025
erenkarakal
pushed a commit
to erenkarakal/Skript
that referenced
this pull request
Nov 26, 2025
* Add example annotation. * Support new annotation in documentation generators. * Update src/main/java/ch/njol/skript/doc/Example.java
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.
SOTU
The examples annotation format currently has three issues:
For example, around 40% of the multi-line examples are currently indented.


The rest are not.
I, personally, dislike this practice because it's not really in line with the code style and it's likely to be erased by auto-reformatting. That said, I understand why it's currently done for clarity.
The New Proposal
Side-by-Side
The current format:

The new (proposed) format:
