[Task]: Normalize `typehint` vs. `type-hint` vs. `type hint` in Python documentation and docstrings

apache / beam

Apache Beam is a unified programming model for Batch and Streaming data processing.

https://beam.apache.org/

Apache License 2.0

7.9k stars 4.27k forks source link

[Task]: Normalize `typehint` vs. `type-hint` vs. `type hint` in Python documentation and docstrings #23950

Open TheNeuralBit opened 2 years ago

TheNeuralBit commented 2 years ago

What needs to happen?

See https://github.com/apache/beam/pull/23909#discussion_r1011974873

We use three different formats to represent "type hint" in Python documentation and docstrings. We should pick one and standardize on it across all documentation on the Beam website and in docstrings.

Issue Priority

Priority: 3

Issue Component

Component: website

ayushthe1 commented 2 years ago

.take-issue

ayushthe1 commented 2 years ago

hey @TheNeuralBit , i made a pr for this issue. Could you please review it.

TheNeuralBit commented 2 years ago

I think we may want to standardize on "type hint" in documentation and "typehint" for code. For reference: PEP 484 uses "type hint".