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

Request support for @deprecated #46

Open
hyperupcall opened this issue Apr 9, 2022 · 0 comments · May be fixed by #73
Open

Request support for @deprecated #46

hyperupcall opened this issue Apr 9, 2022 · 0 comments · May be fixed by #73

Comments

@hyperupcall
Copy link
Contributor

hyperupcall commented Apr 9, 2022

I think it would be quite useful to have a @deprecated flag. Unlike @internal, I believe the documentation for the function should actually be generated, but show some notice somewhere that it is deprecated. More specifically, changing a function subheading in the markdown from ### core.init() to ### core.init() (deprecated) comes to mind, but perhaps another layout could look nicer.

Real-world uses of this functionality can be found here and here

Is there any interest in this? I'd be happy to make a PR for this :)

@hyperupcall hyperupcall linked a pull request Oct 11, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant