Actions
Idea #20906
closed
Get PySDK deprecation notices into the web documentation
Status:
Rejected
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
-
Start date:
Due date:
Story points:
-
Description
In #20839 we added a decorator that marks a function as deprecated. The wrapper function both records a DeprecationWarning when called, and also has a modified version of the original function's docstring to include the same information.
This implementation works fine for pydoc, but the deprecation notices don't appear in the web documentation. It would be ideal if we could find a way to do that while still using the single decorator for everything.
Investigate options and implement one if practical.
Updated by Brett Smith over 2 years ago
- Target version deleted (
Future) - Status changed from New to Rejected
This is not a real issue, the web docs are fine. I was probably reviewing docs that were generated from some branch that doesn't have #20839 merged yet.
Actions