Opened 14 years ago

Last modified 12 years ago

#3048 enhancement new

add support for twisted.python.deprecate's docstring manipulation to pydoctor

Reported by: Jean-Paul Calderone Owned by:
Priority: normal Milestone: totally automated release infrastructure
Component: pydoctor Keywords:
Cc: therve Branch:
Author:

Description

twisted.python.deprecate rewrites docstrings to include deprecation information.

It would be excellent if pydoctor supported this in some way, either by reflecting the modified docstring in its output or by marking up the output to indicate the deprecation in some other way.

Since the decorator is in use already, it would be nice for this to be done for the next release, so the generated documentation reflects these new deprecations.

Change History (4)

comment:1 Changed 14 years ago by therve

Cc: therve added

I hacked some stuff in http://bazaar.launchpad.net/~therve/pydoctor/handle-deprecated. It's not very clean, but it did the job. I use the livecheck option, but instead of loading every module, it loads only the modules flagged by hand. I flagged the module where I detected a name = func(name) at module level (which is approximately what we do with deprecated decorator).

Michael, can you have a look? I can work on this more if you have some pointers.

comment:2 Changed 14 years ago by radix

Milestone: twisted-8.0regular-releases

comment:3 Changed 12 years ago by Jean-Paul Calderone

Hm.

Pydoctor should really use launchpad for issue tracking. I'm tempted to close this as invalid. However, this code is all intimately Twisted specific, is it not? Does it really belong in pydoctor? Should it instead be in Twisted and loaded by pydoctor via some extension mechanism?

comment:4 Changed 11 years ago by <automation>

Owner: Michael Hudson-Doyle deleted
Note: See TracTickets for help on using tickets.