Skip to content

Exclude some fields from documentation without making them private #11

Description

@momchil-flex

There are some inherited fields that in some classes can be modified by the users, while in others they can't be (set as Literal[single_option] = single_option). To avoid confusion, it could be better to completely avoid documenting those fields in classes where they cannot be modified.

The two examples currently are monitor.colocate in some monitors, and monitor.interval_space in some monitors. There could be others in the future too.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions