Skip to content

Commit

Permalink
Move typing examples into tests
Browse files Browse the repository at this point in the history
To prevent confusion
  • Loading branch information
hynek committed Jun 7, 2023
1 parent 991c53d commit 34d9b6d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If an item doesn't apply to your pull request, **check it anyway** to make it ap
-->

- [ ] Added **tests** for changed code.
- [ ] **New or changed APIs** are added to [`typing_examples.py`](https://github.com/hynek/environ-config/blob/main/typing_examples.py).
- [ ] **New or changed APIs** are added to our [typing examples](https://github.com/hynek/environ-config/blob/main/tests/typing/api.py) to ensure our external type hints are sound.
- [ ] Updated **documentation** for changed code.
- [ ] New functions/classes have to be added to `docs/api.md` by hand.
- [ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded).
Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def coverage_report(session: nox.Session) -> None:
def mypy(session: nox.Session) -> None:
session.install(".", "mypy")

session.run("mypy", "typing_examples.py")
session.run("mypy", "tests/typing")


@nox.session(python=DOCS_PYTHON)
Expand Down
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ classifiers = [
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Software Development :: Libraries :: Python Modules",
"Typing :: Typed",
]
dependencies = ["attrs>=17.4.0", "importlib_metadata; python_version<'3.8'"]

Expand Down Expand Up @@ -109,6 +110,10 @@ ignore_missing_imports = true
module = "tests.*"
ignore_errors = true

[[tool.mypy.overrides]]
module = "tests.typing.*"
ignore_errors = false


[tool.hatch.metadata.hooks.fancy-pypi-readme]
content-type = "text/markdown"
Expand Down
File renamed without changes.

0 comments on commit 34d9b6d

Please sign in to comment.