Skip to content

Update documentation regarding entry points#1923

Merged
sigmavirus24 merged 4 commits intoPyCQA:mainfrom
Viicos:entry-points-docs
Mar 19, 2024
Merged

Update documentation regarding entry points#1923
sigmavirus24 merged 4 commits intoPyCQA:mainfrom
Viicos:entry-points-docs

Conversation

@Viicos
Copy link
Contributor

@Viicos Viicos commented Mar 14, 2024

Fixes #1920.

Refer to the PyPA packaging guide
Replace references to the deprecated `pkg_resources` docs

All plugins for |Flake8| must be registered via `entry points`_. In this
All plugins for |Flake8| must be registered via
:external:doc:`entry points<specifications/entry-points>`. In this
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please user the :external+<name>:doc:... syntax for this, e.g, :external+setuptools:

Copy link
Member

@sigmavirus24 sigmavirus24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it will be better to be explicit about where we expect these docs to come from. If the links break, then it will be very confusing to debug which intersphinx mapping it is meant to come from and which one to look for to fix it

@Viicos Viicos force-pushed the entry-points-docs branch from 52d9f29 to 350f254 Compare March 17, 2024 19:03
@sigmavirus24
Copy link
Member

Thank you @Viicos

@sigmavirus24 sigmavirus24 merged commit 33e5083 into PyCQA:main Mar 19, 2024
@Viicos Viicos deleted the entry-points-docs branch March 19, 2024 11:20
@Viicos
Copy link
Contributor Author

Viicos commented Mar 19, 2024

Thanks for wrapping up

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.

Update plugin registration documentation about entry points

2 participants