flytekit.Documentation#

class flytekit.Documentation(short_description=None, long_description=None, source_code=None)[source]#

DescriptionEntity contains detailed description for the task/workflow/launch plan. Documentation could provide insight into the algorithms, business use case, etc. :param short_description: One-liner overview of the entity. :type short_description: str :param long_description: Full user description with formatting preserved. :type long_description: Optional[Description] :param source_code: link to source code used to define this entity :type source_code: Optional[SourceCode]

Methods

Parameters

short_description (Optional[str]) –
long_description (Optional[flytekit.models.documentation.Description]) –
source_code (Optional[flytekit.models.documentation.SourceCode]) –

Return type

None

classmethod from_flyte_idl(pb2_object)[source]#

Parameters: pb2_object (flyteidl.admin.description_entity_pb2.DescriptionEntity) –
Return type: flytekit.models.documentation.Documentation

serialize_to_string()#

Return type: str

short_string()#

Return type: Text

to_flyte_idl()[source]#

verbose_string()#

Return type: Text

Attributes

is_empty

long_description: Optional[flytekit.models.documentation.Description] = None

short_description: Optional[str] = None

source_code: Optional[flytekit.models.documentation.SourceCode] = None