You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2019/12/03 03:13:00 UTC

[jira] [Updated] (FLINK-14198) Add type options to all flink python API doc

     [ https://issues.apache.org/jira/browse/FLINK-14198?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

ASF GitHub Bot updated FLINK-14198:
-----------------------------------
    Labels: pull-request-available  (was: )

> Add type options to all flink python API doc
> --------------------------------------------
>
>                 Key: FLINK-14198
>                 URL: https://issues.apache.org/jira/browse/FLINK-14198
>             Project: Flink
>          Issue Type: Improvement
>          Components: API / Python
>            Reporter: Wei Zhong
>            Assignee: Wei Zhong
>            Priority: Minor
>              Labels: pull-request-available
>
> 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. 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)