Skip to content

Commit d94e4a9

Browse files
committed
README & Classifier tweaks
Who doesn't love badges :)
1 parent c2d54f5 commit d94e4a9

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# flake8-annotations
22
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flake8-annotations)](https://pypi.org/project/flake8-annotations/)
33
[![PyPI](https://img.shields.io/pypi/v/flake8-annotations)](https://pypi.org/project/flake8-annotations/)
4+
[![PyPI - License](https://img.shields.io/pypi/l/flake8-annotations?color=magenta)](https://github.com/sco1/flake8-annotations/blob/master/LICENSE)
5+
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
6+
[![Code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
47

5-
`flake8-annotations` is a plugin for [Flake8](http://flake8.pycqa.org/en/latest/) that detects the absence of [PEP 3107-style](https://www.python.org/dev/peps/pep-3107/) function annotations and [PEP 484-style](https://www.python.org/dev/peps/pep-0484/#type-comments) type comments (see: [Caveats](#Caveats-for-PEP-484-style-Type-Comments)).
8+
`flake8-annotations` is a plugin for [Flake8](http://flake8.pycqa.org/en/latest/) that detects the absence of [PEP 3107-style](https://www.python.org/dev/peps/pep-3107/) function annotations and [PEP 484-style](https://www.python.org/dev/peps/pep-0484/#type-comments) type comments (see: [Caveats](#Caveats-for-PEP-484-style-Type-Comments)).
69

710
What this won't do: Check variable annotations (see: [PEP 526](https://www.python.org/dev/peps/pep-0526/)), respect stub files, or replace [mypy](http://mypy-lang.org/).
811

@@ -96,7 +99,7 @@ Decorators are matched based on their attribute name. For example, `"singledispa
9699

97100
**NOTE:** Deeper imports, such as `a.b.singledispatch` are not supported.
98101

99-
See [Generic Functions](#generic-functions) for additional information.
102+
See: [Generic Functions](#generic-functions) for additional information.
100103

101104
Default: `"singledispatch, singledispatchmethod"`
102105

@@ -110,7 +113,7 @@ Decorators are matched based on their attribute name. For example, `"overload"`
110113

111114
**NOTE:** Deeper imports, such as `a.b.overload` are not supported.
112115

113-
See [The `typing.overload` Decorator](#the-typingoverload-decorator) for additional information.
116+
See: [The `typing.overload` Decorator](#the-typingoverload-decorator) for additional information.
114117

115118
Default: `"overload"`
116119

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ classifiers = [
1313
"Intended Audience :: Developers",
1414
"License :: OSI Approved :: MIT License",
1515
"Operating System :: OS Independent",
16+
"Development Status :: 5 - Production/Stable",
1617
"Programming Language :: Python",
1718
"Programming Language :: Python :: 3",
1819
"Programming Language :: Python :: 3.6",
@@ -22,6 +23,7 @@ classifiers = [
2223
"Programming Language :: Python :: 3 :: Only",
2324
"Topic :: Software Development :: Libraries :: Python Modules",
2425
"Topic :: Software Development :: Quality Assurance",
26+
"Typing :: Typed",
2527
]
2628
include = ["CHANGELOG.md"]
2729

0 commit comments

Comments
 (0)