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

Deprecation Annotation | Skript Syntaxes #10

Open
Fusezion opened this issue Dec 27, 2022 · 4 comments
Open

Deprecation Annotation | Skript Syntaxes #10

Fusezion opened this issue Dec 27, 2022 · 4 comments
Assignees
Labels
backend Issues that require backend code changes (java) enhancement Feature request, an issue about something that could be improved, or a PR improving something. frontend Issues that require frontend code changes (HTML, CSS, JS) priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements).

Comments

@Fusezion
Copy link

Fusezion commented Dec 27, 2022

Is this exclusive to just skript methods or would be it also be something good for skript syntax aswell?

An example case for this would be if there was ever a PR for raytrace syntax, for the most part that is just a better target block and target entity as it acts more like an exact target entity. In that case I'd view it as a means for a deprecation/removal of the target syntaxes *could also just be time for an update to raytrace

Originally posted by @Fusezion in SkriptLang/Skript#5278 (comment)


Suggestion

As I stated above, I believe there should also be a new annotation in skript just like the @MarkedForRemoval but this time aimed for general skript syntax such as @Deprecation

Why

In the example above I mentioned we could theoretically remove the target block and target entity expressions if we were to ever add support for raytracing in skript. That's due to the fact raytracing is a just much exact hit compared to target attempting to get "around" it as it treats all blocks as full blocks

Adding this does another thing which is prevent removal of largely used syntax feeling like it randomly happened we'd be able to now mark stuff as Deprecated early on after introducing something to replace it and wait a few(1-2) major versions then remove it.

@AyhamAl-Ali AyhamAl-Ali self-assigned this Dec 28, 2022
@AyhamAl-Ali AyhamAl-Ali 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 28, 2022
@AyhamAl-Ali
Copy link
Member

Just to clarify this,

  • Adding support for @Deprecated annotation to appear on syntax elements on docs (just line new red tag)
  • Possibly add support for deprecation reason with a hyperlink (hover for description & click for hyperlink)

@Fusezion
Copy link
Author

Just to clarify this,

  • Adding support for @Deprecated annotation to appear on syntax elements on docs (just line new red tag)
  • Possibly add support for deprecation reason with a hyperlink (hover for description & click for hyperlink)

I like the idea of making it like @Description() for adding reasonings and such but I'm lost with the deprecation reason with a hyperlink (hover for description & click for hyperlink) part where would the hyperlink come into play for it?

@AyhamAl-Ali
Copy link
Member

but I'm lost with the deprecation reason with a hyperlink (hover for description & click for hyperlink) part where would the hyperlink come into play for it?

It's used as in favor of another element, a link to the other element

@AyhamAl-Ali AyhamAl-Ali transferred this issue from SkriptLang/Skript Jan 23, 2023
@Fusezion
Copy link
Author

Fusezion commented Jan 23, 2023

god damn don't scare me like that
thought i was hacked

image

@AyhamAl-Ali AyhamAl-Ali added backend Issues that require backend code changes (java) frontend Issues that require frontend code changes (HTML, CSS, JS) labels Jan 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Issues that require backend code changes (java) enhancement Feature request, an issue about something that could be improved, or a PR improving something. frontend Issues that require frontend code changes (HTML, CSS, JS) 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