diff --git a/.copier-answers.yml b/.copier-answers.yml index a80d120..c1850c8 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -2,7 +2,7 @@ # Answer file maintained by Copier for: https://github.com/KyleKing/mdformat-plugin-template # DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions # Check into version control. -_commit: 0.1.4 +_commit: 0.1.6 _src_path: gh:KyleKing/mdformat-plugin-template author_email: dev.act.kyle@gmail.com author_name: Kyle King diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d705910..c2a51a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,14 @@ # Development +## API Documentation + +A collection of useful resources to reference when developing new features: + +- [`markdown-it-py` documentation](https://markdown-it-py.readthedocs.io/en/latest/using.html) +- [`markdown-it` (JS) documentation](https://markdown-it.github.io/markdown-it) + +## Local Development + This package utilizes [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation. To install these development dependencies: diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..4e9bc90 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,14 @@ +"""Ignore beartype warnings from tests.""" + +from contextlib import suppress + +with suppress(ImportError): # Only suppress beartype warnings when installed + from warnings import filterwarnings + + from beartype.roar import ( + BeartypeClawDecorWarning, # Too many False Positives using NamedTuples + BeartypeDecorHintPep585DeprecationWarning, + ) + + filterwarnings("ignore", category=BeartypeClawDecorWarning) + filterwarnings("ignore", category=BeartypeDecorHintPep585DeprecationWarning)