Skip to content

Support for decorated functions #14

@a-delannoy

Description

@a-delannoy

Summary

It could make sense to somehow introduce in the generated documentation information about the possible decorators on top of the documented functions (and classes maybe).

Example

For example, common decorators, like @overload or @property, are invisible in the generated documentation. A function decorated with those would just appear several times in the doc, with no hint about it.

Your opinion on this ?

Since it is a common pattern in python to use decorators, introducing an annotation about it might help ease the navigate through the generated documentation.

Do you think it could make sense to improve the lib towards that direction ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions