search

jaraco / skeleton

A generic project skeleton for Python projects.
http://blog.jaraco.com/skeleton/
MIT License
123 stars 36 forks source link

Document convention on compat modules #145

Closed abravalheri closed 3 weeks ago

abravalheri commented 2 months ago

This PR is a follow up on the discussion in https://github.com/pypa/setuptools/pull/4609 (the same changes as presented in setuptools, largely borrowed from the initial comments in https://github.com/pypa/setuptools/pull/4212 and slightly tweaked).

I have not expanded on the why compat instead of _compat (the rationale is presented in https://github.com/pypa/setuptools/pull/4609#issuecomment-2316801191), but I can try to add something regarding that too.

I have not added anything yet about extracting reusable shims to jaraco.compat, but that can also be added if necessary.