Skip to content

Commit

Permalink
docs: Remove reference to type comments
Browse files Browse the repository at this point in the history
This project has never supported Python 2.7, and has never used type
comments for function annotations.
  • Loading branch information
godlygeek authored and pablogsal committed Apr 19, 2022
1 parent 020e650 commit 00cbecf
Showing 1 changed file with 0 additions and 5 deletions.
5 changes: 0 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ pleasant to read when browsing the source.
All functions and methods should be type annotated. This allows for static analysis and more
intelligent code completion from tools & IDEs.

Type annotations must use [type comment](#py27-type-comment) annotations until 2.7 support is
completely phased out. Please see [PEP 484][] for details on definitions and tools surrounding type
annotations.

## Tests

Changes should always include tests. If this is a bug fix it is a good idea to add the tests as the
Expand All @@ -60,7 +56,6 @@ of the PR.
[pep 257]: https://www.python.org/dev/peps/pep-0257/ "Docstring Conventions"
[pep 484]: https://www.python.org/dev/peps/pep-0484/ "Type Hints"
[google-style]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html "Example Google Style Python Docstrings"
[py27-type-comment]: https://www.python.org/dev/peps/pep-0484/#suggested-syntax-for-python-2-7-and-straddling-code "Suggested syntax for Python 2.7 and straddling code"
[builtin-help]: https://docs.python.org/3/library/functions.html#help

<!--
Expand Down

0 comments on commit 00cbecf

Please sign in to comment.