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.

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

Clarify entry point naming #1646

Merged
merged 1 commit into from Aug 2, 2022
Merged

Clarify entry point naming #1646

merged 1 commit into from Aug 2, 2022

Conversation

televi
Copy link
Contributor

@televi televi commented Aug 1, 2022

Clarified what is and is not a valid entry point name
for registering plugins.

In the above, ``X`` is the entry point prefix and ``X101`` is the
entry point name.
Copy link
Member

@asottile asottile Aug 1, 2022

Choose a reason for hiding this comment

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

ah so actually both X and X101 are used as the entry point name (which is the prefix) -- the error code is X101

Copy link
Contributor Author

@televi televi Aug 1, 2022

Choose a reason for hiding this comment

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

Looks like I wasn't fully understanding that still. I was looking at "ABC" and "123" as 2 different parts of the entry point name. I saw how the combination was the error code (or error code "prefix" in the case of something like X1 or just X). I added this to try to capture your comment about 3 letters being the max prefix length - I was trying to define what the "prefix" meant for an entry point. Would "In the above, you can think of the letters as a prefix to the entry point name." be better or maybe just leave those two lines out?

Copy link
Member

@asottile asottile Aug 1, 2022

Choose a reason for hiding this comment

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

the entry point is the prefix of the codes that the plugin produces -- I think that's the important part from this section

Copy link
Contributor Author

@televi televi Aug 2, 2022

Choose a reason for hiding this comment

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

Ah - that's a much cleaner way to express it! I'll push an update that (hopefully) reflects that cleanly.

Clarified what is and is not a valid entry point name
for registering plugins.
Copy link
Member

@asottile asottile left a comment

@asottile asottile merged commit 318a86a into PyCQA:main Aug 2, 2022
11 checks passed
@televi
Copy link
Contributor Author

televi commented Aug 2, 2022

Thank you so much for your help and great comments/insights! I love the cat gif!

@asottile
Copy link
Member

asottile commented Aug 2, 2022

Thank you so much for your help and great comments/insights! I love the cat gif!

heh -- I have a user script which auto-posts them https://www.youtube.com/watch?v=2rDNJvHznrM

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.

None yet

2 participants