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

Optimize Python API doc

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • 1.14.5, 1.15.1, 1.16.0
    • None
    • API / Python, Documentation
    • None

    Description

      The overall style and structure of the current python api doc is not so convenient to new users to learn and use, we can use numpydoc or other document styles to optimize.

      Attachments

        Issue Links

          is a parent of

          Sub-task - The sub-task of the issue FLINK-30040 Add more PyFlink API examples

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. FLINK-29966 Replace and redesign the Python api documentation base

          • Major - Major loss of function.
          • Closed

          Activity

            People

              hxbks2ks Huang Xingbo
              hxbks2ks Huang Xingbo
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: