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

[Feature] - Use standard denotation for deprecated functions + offer alternatives #349

Open
multimokia opened this issue Jun 21, 2023 · 2 comments
Labels
backlog Something that is not a priority and will be addressed in a future release enhancement Small improvements

Comments

@multimokia
Copy link
Contributor

multimokia commented Jun 21, 2023

image

Currently the renpy extension reports deprecations, however it does so in a way nonstandard to other languages, for example in Javascript/Typescript/C# will use strikeout and an additional line flagging it as deprecated which also shows in intellisense:

image
image

I think it'd be great to use this format to standardize.
Likewise I think it'd go a long way to link docs to what the best way to replace deprecated functions or simply suggest right in the hover docs

@multimokia
Copy link
Contributor Author

Adding onto this, it may be worth having some version rules as it could be possible to come across things that don't exist, or items being marked as deprecated even if the current version of the engine being used doesn't have alternatives or it's not deprecated in that version

@duckdoom4
Copy link
Collaborator

Hi, thanks for the suggestion. Currently we just pull this information from the renpy documentation (git repo) using a custom script. If this info is not in the documentation, we don't add it.

As for the other suggestion, yes, I also think we should use convention formatting (aka. strikethrough)

@duckdoom4 duckdoom4 added enhancement Small improvements backlog Something that is not a priority and will be addressed in a future release labels Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Something that is not a priority and will be addressed in a future release enhancement Small improvements
Projects
None yet
Development

No branches or pull requests

2 participants