Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EventValue Docs #7290

Open
1 task done
TheAbsolutionism opened this issue Dec 20, 2024 · 0 comments
Open
1 task done

EventValue Docs #7290

TheAbsolutionism opened this issue Dec 20, 2024 · 0 comments
Labels
enhancement Feature request, an issue about something that could be improved, or a PR improving something. priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements).

Comments

@TheAbsolutionism
Copy link
Contributor

TheAbsolutionism commented Dec 20, 2024

Suggestion

When registering an EventValue, add a description field allowing a description to be displayed on the SkriptLang Docs
As well as custom EventValueExpressions, such as victim and attacker, correlating the registered expression to the event with an optional description that way it can be listed with the event docs.

Why?

I feel like this would be beneficial to Skript users as well as maintaining the EventValues, to show what exactly this event-value is, where it's from, and how it's used.
For the EventValueExpressions, would be nice to have it linked to the docs through the event values field.

Other

I know this might not feasible, it would have to include reworking the docs website. Just a thought.

Agreement

  • I have read the guidelines above and affirm I am following them with this suggestion.
@Efnilite Efnilite added enhancement Feature request, an issue about something that could be improved, or a PR improving something. priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements). labels Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature request, an issue about something that could be improved, or a PR improving something. priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements).
Projects
None yet
Development

No branches or pull requests

2 participants