Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation regarding entry points #1923

Merged
merged 4 commits into from Mar 19, 2024
Merged

Update documentation regarding entry points #1923

merged 4 commits into from Mar 19, 2024

Conversation

Viicos
Copy link
Contributor

@Viicos Viicos commented Mar 14, 2024

Fixes #1920.

@Viicos
Update documentation regarding entry points
49f52a8 
Refer to the PyPA packaging guide
Replace references to the deprecated `pkg_resources` docs
sigmavirus24
sigmavirus24 reviewed Mar 16, 2024
View reviewed changes
docs/source/plugin-development/index.rst Outdated
@@ -30,7 +30,8 @@ To get started writing a |Flake8| :term:`plugin` you first need:

Once you've gathered these things, you can get started.

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:

sigmavirus24
sigmavirus24 requested changes Mar 16, 2024
View reviewed changes
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

@sigmavirus24
Copy link
Member

Thank you @Viicos

@sigmavirus24 sigmavirus24 merged commit 33e5083 into PyCQA:main Mar 19, 2024
11 checks passed
@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
Reviewers

@sigmavirus24 sigmavirus24 sigmavirus24 requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update plugin registration documentation about entry points
2 participants
@Viicos @sigmavirus24