Skip to content

Experiment descriptions#8105

Merged
Efnilite merged 21 commits intodev/featurefrom
feature/feature-descriptions
Dec 10, 2025
Merged

Experiment descriptions#8105
Efnilite merged 21 commits intodev/featurefrom
feature/feature-descriptions

Conversation

@Efnilite
Copy link
Member

@Efnilite Efnilite commented Aug 1, 2025

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

@Efnilite Efnilite added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Aug 1, 2025
@Efnilite Efnilite added the documentation Related to Skript's official documentation. label Aug 1, 2025
@Efnilite Efnilite requested review from a team and AyhamAl-Ali as code owners August 1, 2025 21:07
@Efnilite Efnilite requested review from sovdeeth and removed request for a team August 1, 2025 21:07
@skriptlang-automation skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Aug 1, 2025
@Efnilite Efnilite changed the title Feature descriptions Experiment descriptions Aug 1, 2025
@skriptlang-automation skriptlang-automation bot removed the needs reviews A PR that needs additional reviews label Aug 1, 2025
@Efnilite Efnilite requested a review from sovdeeth August 2, 2025 09:40
@Efnilite Efnilite moved this to In Review in 2.13 Releases Aug 5, 2025
@Efnilite Efnilite requested a review from sovdeeth August 20, 2025 18:29
@Efnilite Efnilite requested a review from sovdeeth August 21, 2025 13:25
@skriptlang-automation skriptlang-automation bot removed the feature-ready A PR/issue that has been approved, tested and can be merged/closed in the next feature version. label Aug 21, 2025
Copy link
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think this could make use of the new Documentable interface? Rather than being required of all experiments.

Copy link
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks just about perfect. I think it'd be good to support some of the other documentation methods, but that can always come later.

Efnilite and others added 2 commits December 9, 2025 00:18
….java

Co-authored-by: Patrick Miller <apickledwalrus@icloud.com>
….java

Co-authored-by: Patrick Miller <apickledwalrus@icloud.com>
@github-project-automation github-project-automation bot moved this from In Review to Awaiting Merge in 2.14 Releases Dec 9, 2025
@skriptlang-automation skriptlang-automation bot added the feature-ready A PR/issue that has been approved, tested and can be merged/closed in the next feature version. label Dec 9, 2025
@Efnilite Efnilite merged commit ba02475 into dev/feature Dec 10, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from Awaiting Merge to Done - Awaiting Release in 2.14 Releases Dec 10, 2025
@Efnilite Efnilite deleted the feature/feature-descriptions branch December 10, 2025 15:22
@APickledWalrus APickledWalrus moved this from Done - Awaiting Release to Done - Released in 2.14 Releases Jan 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Related to Skript's official documentation. enhancement Feature request, an issue about something that could be improved, or a PR improving something. feature-ready A PR/issue that has been approved, tested and can be merged/closed in the next feature version.

Projects

Status: Done - Released

Development

Successfully merging this pull request may close these issues.

6 participants

Comments