[
https://issues.apache.org/jira/browse/BEAM-1694?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15906459#comment-15906459
]
ASF GitHub Bot commented on BEAM-1694:
--------------------------------------
GitHub user tibkiss opened a pull request:
https://github.com/apache/beam/pull/2228
[BEAM-1694] Fix docstring inaccuracies in Python-SDK
Be sure to do all of the following to help us incorporate your contribution
quickly and easily:
- [ ] Make sure the PR title is formatted like:
`[BEAM-<Jira issue #>] Description of pull request`
- [ ] Make sure tests pass via `mvn clean verify`. (Even better, enable
Travis-CI on your fork and ensure the whole test matrix passes).
- [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
number, if there is one.
- [ ] If this contribution is large, please file an Apache
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.txt).
---
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/tibkiss/beam BEAM-1694
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam/pull/2228.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #2228
----
commit 551919a359e3ef16db15e2e10f98ef258f655a33
Author: Tibor Kiss <[email protected]>
Date: 2017-03-11T06:13:04Z
[BEAM-1694] Fix docstring inaccuracies in Python-SDK
----
> Fix docstring inaccuracies in Python-SDK
> ----------------------------------------
>
> Key: BEAM-1694
> URL: https://issues.apache.org/jira/browse/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
(v6.3.15#6346)
