Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-14198

Add type options to all flink python API doc

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: API / Python
    • Labels:
      None

      Description

      Currently ":type:" and ":rtype:" options in python docstrings have been fully supported in sphinx(https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) and PyCharm(https://www.jetbrains.com/help/pycharm/using-docstrings-to-specify-types.html). Sphinx will generate python API documents with type annotations if these options exist in function docstrings. PyCharm also collects the type information in docstrings to detect potential coding mistakes and provide autocomplete support during python program development. There are already few interfaces in python API that have these options. We should add these options to the rest. 

        Attachments

          Activity

            People

            • Assignee:
              zhongwei Wei Zhong
              Reporter:
              zhongwei Wei Zhong
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: