iode.Database.description

Note

Below, Database represents either:

• Comments

• Equations

• Identities

• Lists

• Scalars

• Tables

• Variables

Database.description()

description: str

Description of the current database.

Parameters:

value: str

New description.

Examples

>>> from iode import SAMPLE_DATA_DIR
>>> from iode import comments
>>> comments.load(f"{SAMPLE_DATA_DIR}/fun.cmt")
>>> comments.description = "test data from file 'fun.cmt'"
>>> comments.description
"test data from file 'fun.cmt'"