Skip to content

Commit

Permalink
Docstring cleanup.
Browse files Browse the repository at this point in the history
Co-authored-by: Danny McCormick <[email protected]>
  • Loading branch information
robertwb and damccorm authored Feb 25, 2025
1 parent 8534f25 commit b98e331
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions sdks/python/apache_beam/yaml/yaml_mapping.py
Original file line number Diff line number Diff line change
Expand Up @@ -886,7 +886,7 @@ def from_pane_info(cls, pane_info):


@beam.ptransform.ptransform_fn
def _ExtractWindowingInfo(pcoll, fields: Optional[Mapping[str, str]] = None):
def _ExtractWindowingInfo(pcoll, fields: Optional[Union[Mapping[str, str], Iterable[str]]] = None):
"""
Extracts the implicit windowing information from an element and makes it
explicit as field(s) in the element itself.
Expand All @@ -903,12 +903,12 @@ def _ExtractWindowingInfo(pcoll, fields: Optional[Mapping[str, str]] = None):
* `pane_info`: A schema'd representation of the current pane info, including
its index, whether it was the last firing, etc.
As a convenience, a list rather than a mapping of fields may be provide,
As a convenience, a list rather than a mapping of fields may be provided,
in which case the fields will be named according to the requested values.
Args:
fields: A mapping of new field names to various windowing parameters,
as documente above. If omitted, defaults to
as documented above. If omitted, defaults to
`[timestamp, window_start, window_end]`.
"""
if fields is None:
Expand Down

0 comments on commit b98e331

Please sign in to comment.