Docs

Select data types can be associated with a string for documentation purposes.

obj = platform.<object>s.get("")
obj.docs = "More information about this object."

The docs property is an instance of DocsDescriptor that supports __get__, __set__ and __delete__.

class ixmp4.core.docs.DocsDescriptor

Handles documentation strings of various objects on a platform.

__set__(obj: BaseFacadeObject[DocsServiceT, DtoT], value: str | None) → None

Sets the documentation string for a facade object. If the supplied value is as string the saved entry will be updated or created. If the value is None the entry will be deleted.

model.docs = "Model documentation string."
model.docs

#> "Model documentation string.

scenario.docs = None
#> Entry deleted.

__get__(obj: BaseFacadeObject[DocsServiceT, DtoT], objtype: type[Any]) → str | None

Retrieves the documentation string for a facade object. If the entry does not exist, the DocsNotFound exception will be caught and None will be returned instead.

region.docs
#> "Region documentation string.

__delete__(obj: BaseFacadeObject[DocsServiceT, DtoT]) → None

Deletes the documentation string for a facade object. If the entry does not exist, the DocsNotFound exception will be caught.

del unit.docs
#> Entry deleted.

unit.docs
#> `None`