Class deprecations should be noted in API
Bug #1229447 reported by
Michael Hudson-Doyle
This bug affects 2 people
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pydoctor |
New
|
Undecided
|
Unassigned |
Bug Description
From https:/
When a class is deprecated, a note should be added by pydoctor to the class API description.
An example is POP3Client. A deprecation warning is issued in its __init__ function. But in the API, it is not obvious that the class should not be used. That comment could be put in explicitly but that would be repeating information.
To post a comment you must log in.
So the question here is how to tell pydoctor that the class is deprecated. The rest should be easy <wink>