apache / apache/beam

Document optional kwargs argument in Partition Ptransform

Open
#19,647 0 comments 0 reactions 0 assignees View on GitHub
bug core P3 python
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

All PTransforms that accept a callable accept kwargs that will be passed to the callable.
Some PTransfoms document that in their docstring, for example, see Map[1].

It looks like Partition transform does not document kwargs in docstring, althougth it also accepts them [2].

[1] https://github.com/apache/beam/blob/05900a43de1f380f124c688cd8d804b5133bda64/sdks/python/apache_beam/transforms/core.py#L1277

[2] https://github.com/apache/beam/blob/05900a43de1f380f124c688cd8d804b5133bda64/sdks/python/apache_beam/transforms/core.py#L1934

Imported from Jira [BEAM-7671](https://issues.apache.org/jira/browse/BEAM-7671). Original Jira may contain additional context.
Reported by: tvalentyn.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.