From 2503fdcedda7a2c1ec11799bf60f0f8db26d66f3 Mon Sep 17 00:00:00 2001 From: clintval Date: Fri, 17 Jan 2025 13:19:09 -1000 Subject: [PATCH] chore: suit review --- CONTRIBUTING.md | 4 ++-- pyproject.toml | 10 +++++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 578b19d..d7144a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,7 +124,7 @@ Use `mkdocs` to build and serve the documentation. poetry run mkdocs build && poetry run mkdocs serve ``` -## Creating a Release on PyPi +## Creating a Release on PyPI 1. Clone the repository recursively and ensure you are on the `main` (un-dirty) branch 2. Checkout a new branch to prepare the library for release @@ -147,7 +147,7 @@ GitHub Actions will take care of the remainder of the deployment and release pro 1. Unit tests will be run for safety-sake 2. A source distribution will be built 3. Multi-arch multi-Python binary distributions will be built -4. Assets will be deployed to PyPi with the new SemVer +4. Assets will be deployed to PyPI with the new SemVer 5. A [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)-aware changelog will be drafted 6. A GitHub release will be created with the new SemVer and the drafted changelog diff --git a/pyproject.toml b/pyproject.toml index cec873c..f55bf51 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -106,6 +106,9 @@ fix-and-check-all.sequence = [ [tool.mypy] files = ["prymer", "tests"] strict_optional = false +# TODO: activate the following checks! +# strict_optional = true +# strict_equality = true check_untyped_defs = true disallow_incomplete_defs = true disallow_untyped_calls = true @@ -119,6 +122,11 @@ warn_unreachable = true warn_unused_configs = true warn_unused_ignores = true exclude = ["site/", "docs/"] +# TODO: activate the following checks! +# enable_error_code = [ +# "ignore-without-code", +# "possibly-undefined", +# ] [[tool.mypy.overrides]] module = ["primer3"] @@ -148,7 +156,7 @@ testpaths = [ [tool.ruff] include = ["prymer/**/*.py", "tests/**/*.py"] line-length = 100 -target-version = "py312" +target-version = "py311" output-format = "full" [tool.ruff.lint]