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

Plugins documentation: setuptools example not found #6121

Closed
1 task done
JeroenBos opened this issue Aug 5, 2022 · 1 comment · Fixed by #6557
Closed
1 task done

Plugins documentation: setuptools example not found #6121

JeroenBos opened this issue Aug 5, 2022 · 1 comment · Fixed by #6557
Labels
area/docs Documentation issues/improvements status/triage This issue needs to be triaged

Comments

@JeroenBos
Copy link

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

I'm having issues interpreting the documentation on plugins. It refers to the setuptools documentation and an example in there, but I can't find that example. Without that it becomes very hard to interpret the snippet of code in that plugin section of your documentation. I don't know if maybe setuptools has changed their documentation? Or if I just can't find it, maybe a more direct link could be added to the documentation, instead of to the main page.


Other than that, I would appreciate if this section just minimally listed what the concepts are that are to be inserted in the example, e.g.

[tool.poetry.plugins."A"]
"B" = "C:D"
  • A: the name your plugin (is it arbitrary, or does it need to match another string?)
  • B: I don't know what goes here. Is it arbitrary or should it meet certain requirements?
  • C: the module that contains the plugin
  • D: the plugin class

This would decouple from the other documentation, and be more helpful standalone. Thank you

@JeroenBos JeroenBos added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Aug 5, 2022
Copy link

github-actions bot commented Mar 1, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements status/triage This issue needs to be triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant