Skip to content

Remove optional dependency on commonmark - #401

Closed
nikolas wants to merge 1 commit into
executablebooks:masterfrom
nikolas:remove-commonmark
Closed

Remove optional dependency on commonmark#401
nikolas wants to merge 1 commit into
executablebooks:masterfrom
nikolas:remove-commonmark

Conversation

@nikolas

@nikolas nikolas commented May 29, 2026

Copy link
Copy Markdown
Contributor

This library was deprecated in 2022.

This library was deprecated in 2022.
chrisjsewell added a commit that referenced this pull request Sep 9, 2026
…#427)

## 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.

---------

Co-authored-by: Nikolas Nyby <nikolas@gnu.org>

Copy link
Copy Markdown
Member

Thanks @nikolas! Your commit has been merged verbatim, with your authorship preserved, via #427 (we could not push to this fork branch to bring it up to date). #427 also removed the orphaned commonmark benchmark and kept the performance-table row with a deprecation footnote. Closing this in favour of #427; it will be in the next release.


Generated by Claude Code

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