Rich Docstring Metadata

[kennyworkman]

Rich Docstring Metadata

Expanded support for docstring metadata

Type

• [ ] Bug Fix
• [x] Feature
• [ ] Plugin

Are all requirements met?

• [ x ] Code completed
• [ ] Smoke tested
• [ x ] Unit tests added (only updated interface tests so team can see some examples)
• [ ] Code documentation added
• [ ] Any pending items have an associated Issue

Complete description

The following pieces of information are extracted from the body:

* short descrption text
* long description text
* YAML serialized long description metadata

The following pieces of information are extracted from each parameter described in the docstring

* name
* description
* index/order
* default value
* YAML serialized parameter description metadata

An example:

    @task
    def foo():
        ""<short description>

        <long description>

        __metadata__:
            <YAML serialized long description metadata>

        Args:
            <param name>:
                <param description>

                __metadata__:
                    <YAML serialized param description metadata>
        """

Tracking Issue

https://github.com/flyteorg/flyte/pull/1856