beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tibor Kiss (JIRA)" <>
Subject [jira] [Created] (BEAM-1694) Fix docstring inaccuracies in Python-SDK
Date Sun, 12 Mar 2017 08:16:04 GMT
Tibor Kiss created BEAM-1694:

             Summary: Fix docstring inaccuracies in Python-SDK
                 Key: BEAM-1694
             Project: Beam
          Issue Type: Bug
          Components: sdk-py
            Reporter: Tibor Kiss
            Assignee: Tibor Kiss
            Priority: Trivial

Certain functions / classes has inaccurate documentation: 
 - missing/non-matching arguments between code & doc
 - arguments present in docstring but not in code
 - single quotation used for docstring

These issues should be fixed to not to mislead developers browsing the API-doc. 

This message was sent by Atlassian JIRA

View raw message