[ https://issues.apache.org/jira/browse/BEAM-2241?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16003995#comment-16003995 ]
ASF GitHub Bot commented on BEAM-2241: -------------------------------------- GitHub user chamikaramj opened a pull request: https://github.com/apache/beam/pull/3036 [BEAM-2241] Renames some python classes and functions that were unnecessarily public Adds a note to documentation of classes that are public but should be only used internally by the SDK (non-user facing classes). Marks some of the modules as experimental. 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`. - [ ] 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.pdf). --- You can merge this pull request into a Git repository by running: $ git pull https://github.com/chamikaramj/beam update_public_api Alternatively you can review and apply these changes as the patch at: https://github.com/apache/beam/pull/3036.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 #3036 ---- commit e6f90ec7b8bd59bd6809edc1aa95e2e894dd2b84 Author: chamik...@google.com <chamik...@google.com> Date: 2017-05-10T02:56:14Z Renames some python classes and functions that were unnecessarily public. Adds a note to documentation of classes that are public but should be only used internally by the SDK (non-user facing classes). Marks some of the modules as experimental. ---- > Correctly mark top level classes and functions as private > --------------------------------------------------------- > > Key: BEAM-2241 > URL: https://issues.apache.org/jira/browse/BEAM-2241 > Project: Beam > Issue Type: Improvement > Components: sdk-py > Reporter: Chamikara Jayalath > Assignee: Chamikara Jayalath > Fix For: 2.0.0 > > > Seems like some of the top level classes and function of Python SDK are > unnecessarily public (does not start with _ ). We should update Python SDK so > that top level classes and functions that are only used within the > corresponding modules are private. Additionally, any top level classes and > functions that are not expected to be used by end-users > (pipeline/source/ptransform authors) should be clearly documented. -- This message was sent by Atlassian JIRA (v6.3.15#6346)