[ 
https://issues.apache.org/jira/browse/BEAM-8784?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

David Cavazos updated BEAM-8784:
--------------------------------
    Description: 
PyDoc: 
[https://beam.apache.org/releases/pydoc/2.12.0/apache_beam.transforms.combiners.html?#apache_beam.transforms.combiners.Top]

The combiners.Top PyDoc still shows the `compare` argument as usable. It is 
deprecated and results in an error in Python 3, but the PyDoc does not reflect 
that.

It should say that the argument is deprecated in favor of using the `key` and 
`reverse` arguments.

  was:
The [combiners.Top 
PyDoc|[https://beam.apache.org/releases/pydoc/2.12.0/apache_beam.transforms.combiners.html?#apache_beam.transforms.combiners.Top]]
 still shows the `compare` argument as usable. It is deprecated and results in 
an error in Python 3, but the PyDoc does not reflect that.

It should say that the argument is deprecated in favor of using the `key` and 
`reverse` arguments.


> Remove deprecated 'compare' argument from combiners.Top in PyDocs
> -----------------------------------------------------------------
>
>                 Key: BEAM-8784
>                 URL: https://issues.apache.org/jira/browse/BEAM-8784
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-py-core
>            Reporter: David Cavazos
>            Priority: Trivial
>
> PyDoc: 
> [https://beam.apache.org/releases/pydoc/2.12.0/apache_beam.transforms.combiners.html?#apache_beam.transforms.combiners.Top]
> The combiners.Top PyDoc still shows the `compare` argument as usable. It is 
> deprecated and results in an error in Python 3, but the PyDoc does not 
> reflect that.
> It should say that the argument is deprecated in favor of using the `key` and 
> `reverse` arguments.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to