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

Turn @deprecated tagged items into /Deprecated/ annotations #749

Closed
RobinD42 opened this Issue Feb 14, 2018 · 0 comments

Comments

Projects
None yet
2 participants
@RobinD42
Member

RobinD42 commented Feb 14, 2018

Operating system: any
wxPython version: any
Stock or custom build: any
Python version: any
Stock or custom build: any

Description of the problem:

We have many cases of explicit deprecation tweaks that we have implemented for one reason or another in the Phoenix etg scripts, but there are lots of items in the wxWidgets interface headers that use the @deprecated tag in their documentation that we are not currently doing anything about other than automatically putting the text in the wxPython documentation. It would be nice to be able to automatically turn those into SIP /Deprecated/ annotations so they will raise a warning when used.

Most of the needed features are already there. It should just be a matter of sensing that a function, method or class item has a @deprecated tag in the docs when pulling the info from the XML in etgtools/extractors.py, and then setting the item's deprecated attribute to True.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment