Add support for @workflow docstring input/output variable description

[mayitbeegh]

Signed-off-by: Sean Lin [email protected]

TL;DR

• Add support for @workflow decorated Python function's docstring input/output variable description.
• Add support for docstring's short/long description for future use
• Add a new class Docstring for passing structured docstring around
• See Add docstring's param descriptions to task's and workflow's input and output variables #557 for more context

Type

• Bug Fix
• Feature
• Plugin

Are all requirements met?

• Code completed
• Smoke tested
• Unit tests added
• Code documentation added
• Any pending items have an associated Issue

Complete description

How did you fix the bug, make the feature etc. Link to any design docs etc

Tracking Issue

flyteorg/flyte#1235

Follow-up issue

NA

[codecov]

Codecov Report

Merging #562 (e94838d) into feat/docstring-to-variable-desc (7a4694a) will increase coverage by 0.01%.
The diff coverage is 93.02%.

@@                         Coverage Diff                         @@
##           feat/docstring-to-variable-desc     #562      +/-   ##
===================================================================
+ Coverage                            85.48%   85.49%   +0.01%     
===================================================================
  Files                                  372      374       +2     
  Lines                                29064    29113      +49     
  Branches                              2321     2324       +3     
===================================================================
+ Hits                                 24844    24891      +47     
- Misses                                3577     3578       +1     
- Partials                               643      644       +1     

Impacted Files	Coverage Δ
flytekit/clients/friendly.py	66.40% <ø> (ø)
flytekit/core/docstring.py	89.47% <89.47%> (ø)
tests/flytekit/unit/core/test_docstring.py	91.11% <91.11%> (ø)
flytekit/core/base_task.py	88.00% <100.00%> (+0.05%)	⬆️
flytekit/core/interface.py	80.54% <100.00%> (ø)
flytekit/core/python_auto_container.py	81.37% <100.00%> (+0.18%)	⬆️
flytekit/core/python_function_task.py	88.11% <100.00%> (+0.11%)	⬆️
flytekit/core/workflow.py	87.70% <100.00%> (+0.03%)	⬆️
tests/flytekit/unit/core/test_interface.py	85.13% <100.00%> (+0.07%)	⬆️
tests/flytekit/unit/core/test_workflows.py	98.79% <100.00%> (+0.05%)	⬆️
... and 2 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7a4694a...e94838d. Read the comment docs.

[welcome]

Congrats on merging your first pull request! 🎉