Documentation#

class flytekit.Description(value=None, uri=None, icon_link=None, format=DescriptionFormat.RST)#

Full user description with formatting preserved. This can be rendered by clients, such as the console or command line tools with in-tact formatting.

Parameters:

  • value (str | None)

  • uri (str | None)

  • icon_link (str | None)

  • format (DescriptionFormat)

class DescriptionFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#
class flytekit.Documentation(short_description=None, long_description=None, source_code=None)#

DescriptionEntity contains detailed description for the task/workflow/launch plan. Documentation could provide insight into the algorithms, business use case, etc. Args:

short_description (str): One-liner overview of the entity. long_description (Optional[Description]): Full user description with formatting preserved. source_code (Optional[SourceCode]): link to source code used to define this entity

Parameters:
class flytekit.SourceCode(link=None)#

Link to source code used to define this task or workflow.

Parameters:

link (str | None)