Skip to content

An option to hide attribute initial values #292

@Maboroshy

Description

@Maboroshy

I'm writing a library that has limited API exposed to a user. Some of the exposed class attributes may be initially set up by functions that are not part of the exposed API or the values can be changed later during init process. Putting such initial values to documentation is useless and even confusing for a user.

I’d like to have an option to disable rendering of attributes initial values. It would be useful if the option could disable rendering class variables values and attribute values set in __init__ separately.

I've considered using google format docstrings that render to a table/list attribute representation without values but the docstrings are not merged for inherited classes which is crucial for my project.

Metadata

Metadata

Assignees

Labels

featureNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions