-
Notifications
You must be signed in to change notification settings - Fork 7
bug(medcat): CU-869bfagqw Rename addons to plugins when referring to external code #263
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
bug(medcat): CU-869bfagqw Rename addons to plugins when referring to external code #263
Conversation
|
Task linked: CU-869bfagqw Allow entry-points based addons |
dcstang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get the intention here to distinguish between external (GLiNER) vs internal code.
Plugin/addon are semantically quite close, similar so might not be able to capture the meaning in one word without more documentation backup.
What would your thoughts be on:
Integration ~ implies something from outside, externally joining into
and
Extension ~ implies growth outwards from internal organisation
I agree - plugin and addon are still quite close. And if we were to go this way, we would want some documentation to back this up.
So you're suggesting MetaCAT and RelCAT to be "extensions" since they extend the (core) functionality and "integration" modules to be externally provided components, regardless of whether they're extension or core component. I'm open to further discussion, but currently still leaning towards addons for things that add on top of the core pipeline and plugins for external code that adds new components (or other functionality). |
dcstang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah understood. I get how extensions could get quite wonky down the line too / be a misnomer.
Well as long as it is carefully documented + kept consistent down the line I'm not opposed to the use of plugins.
dcstang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sweet! The code examples help distinguish the concepts and helps me understand how I can make my own plugins. Also useful to denote components as well in this doc.
|
agree - docs more important the literal name |
There's been some confusion introduced by #259 . That's because it refers to external pieces of code as "addons". Yet previously we'd been referring to addons to the name pipe (NER + EL) addons (e.g MetaCAT, RelCAT). This can (and most likely would if kept this way) create confusion for users and developers alike.
So this PR makes a distinction:
This should be a sufficient distinction. And I feel like it's in line with a lot of other things.
Though I'm open to discussions on the naming.