TechnoteState#

class technote.config.TechnoteState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: str, Enum

Standardized states for a technote.

flowchart LR planning --> active active --> stable stable --> active stable --> deprecated active --> deprecated

Attributes Summary

active

The technote is being actively drafted and updated.

deprecated

The technote is no longer relevant and accurate, and may have been replaced by other documents.

other

The technote's state is not described by the controlled vocabulary.

planning

The technote is being researched and planned, but may not have useful content yet.

stable

The content is considered stable and intended to be complete and accurate.

Attributes Documentation

active = 'active'#

The technote is being actively drafted and updated. It may not be complete.

deprecated = 'deprecated'#

The technote is no longer relevant and accurate, and may have been replaced by other documents.

other = 'other'#

The technote’s state is not described by the controlled vocabulary. Use the TechnoteStatus.note field to explain.

planning = 'planning'#

The technote is being researched and planned, but may not have useful content yet.

stable = 'stable'#

The content is considered stable and intended to be complete and accurate.