Skip to content

Plugins documentation: setuptools example not found #6121

@JeroenBos

Description

@JeroenBos
  • 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation issues/improvementsstatus/triageThis issue needs to be triaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions