iode.Comments.description

property Comments.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")
Loading .../fun.cmt
317 objects loaded 
>>> comments.description = "test data from file 'fun.cmt'"
>>> comments.description
"test data from file 'fun.cmt'"