Fix Docs Example Formatting #7992
Merged
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
APickledWalrus
requested review from
Pikachu920,
AyhamAl-Ali,
Efnilite and
a team
as code owners
APickledWalrus
added
the
bug
skriptlang-automation
bot
added
the
needs reviews
1 task
sovdeeth
approved these changes
Jul 2, 2025
Absolutionism
approved these changes
Jul 2, 2025
skriptlang-automation
bot
added
feature-ready
Efnilite
approved these changes
Jul 3, 2025
github-project-automation
bot
moved this from In Review
to Awaiting Merge
in 2.12 Releases
skriptlang-automation
bot
added
completed
Burbulinis
pushed a commit
to Burbulinis/Skript
that referenced
this pull request
Jul 9, 2025
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
When using the
@Exampleannotation, text blocks (multiline strings) are not properly formatted:Solution
This PR rewrites how the combined examples string is formatted. The existing
replacecalls were not working correctly nor do they appear to be necessary. I removed them. Tabs are already handled later on in the code, and replacing them with spaces would not actually work (would need to be nbsp)Additionally, an extra blank line is inserted between different
@Examples for clarity on the docs.Testing Completed
I manually generated the docs and confirmed the issue was resolved:
Supporting Information
Completes: #7813
Related: none