GeoEco.Metadata.AddClassMetadata

GeoEco.Metadata.AddClassMetadata(cls, shortDescription, longDescription=None, module=None)

Creates a ClassMetadata for a class and adds it to a ModuleMetadata.

Parameters:

• cls (type or str) – The class itself, or the unqualified name of the class (without module or package names).

• shortDescription (str) – One-line description of the class, ideally as plain text (but reStructuredText is OK).

• longDescription (str, optional) – Detailed description of the class, formatted as reStructuredText.

• module (ModuleType or str, optional) – The module that contains the class, either as the module object itself or the fully qualified name of the module (a.k.a. dotted module name). If not provided, the caller’s module is used.

Note

Before calling this function, use AddModuleMetadata() to create the ModuleMetadata and attach it to the module.