jangada.mixin.Describable.description

Describable.description: str

Free-form descriptive text.

Extended context, documentation, or explanatory information. Can be multiline and arbitrarily long. Intended for detailed information that doesn’t fit in a short name.

See also

Nameable.name

Short display name

Notes

Descriptions are for extended information - use name for short labels. No formatting is applied - if you need formatted text (markdown, HTML), store it as a string and format at display time.

Common use cases: detailed documentation, usage instructions, configuration notes, debugging context, help text in UIs.

Examples

Basic usage:

obj.description = "This sensor monitors ambient temperature."

Multiline text:

obj.description = '''
This is a detailed description.
It can span multiple lines.
Useful for documentation.
'''

Very long text:

obj.description = "Long documentation..." * 1000  # No limit

Normalization (same as name):

obj.description = "  Text  "
assert obj.description == "Text"

obj.description = ""
assert obj.description is None