Skip to content

🔧 Remove optional dependency on the unmaintained commonmark package - #427

Merged
chrisjsewell merged 6 commits into
masterfrom
claude/pr-401
Sep 9, 2026
Merged

🔧 Remove optional dependency on the unmaintained commonmark package#427
chrisjsewell merged 6 commits into
masterfrom
claude/pr-401

Conversation

@chrisjsewell

@chrisjsewell chrisjsewell commented Sep 9, 2026

Copy link
Copy Markdown
Member

Summary

Supersedes #401 by @nikolas, whose fork does not allow maintainer pushes; their commit is carried here verbatim with authorship preserved (thank you!).

The commonmark PyPI package was deprecated in 2022 (last release 2019). #401 dropped it from the compare extra but left benchmarking/bench_packages.py::test_commonmark_py importing it unguarded, so tox -e py311-bench-packages (which installs benchmarking,compare) would have errored. This PR removes that benchmark too.

The commonmark-py row in docs/performance.md is kept, with a footnote explaining that the package is deprecated, has been removed from the benchmark suite, and that the figures are from the last run that included it. The historical comparison is still informative.

A changelog line with the rationale is added.

Commits

  1. Remove optional dependency on commonmark — the contributor's commit, unchanged.
  2. 🔧 MAINTAIN: Remove remaining commonmark references — drops the orphaned benchmark, adds the changelog line.
  3. 📚 DOCS: Keep the commonmark-py benchmark row, with a deprecation footnote, plus a changelog wording tweak.

Verification

  • All tests pass; all pre-commit hooks pass under the new pins.
  • Local docs build renders the footnote and adds no warnings over master.
  • Remaining commonmark mentions in pyproject.toml, tox.ini and benchmarking/ refer to the CommonMark spec or the commonmark preset, none to the package.

nikolas and others added 6 commits September 9, 2026 12:02
This library was deprecated in 2022.
The `commonmark` package is no longer an optional dependency, so drop
the benchmark that imports it (it would fail `tox -e py311-bench-packages`)
and its row in the performance table, and note the change in the changelog.
@chrisjsewell
chrisjsewell merged commit a5950ca into master Sep 9, 2026
13 checks passed
@chrisjsewell
chrisjsewell deleted the claude/pr-401 branch September 9, 2026 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants