Skip to content

General naming consistencies -- fix + document + ensure best practices moving forward: #498

Open
@elijahbenizzy

Description

@elijahbenizzy

Is your feature request related to a problem? Please describe.
Too early in the library to have these -- we need to keep backwards compatibility but want to make it consistent/easy to reason about.

Specifically:

  1. a_<plugin> versus plugin (done to distinctify async)
    • When should/should these ever live together?
    • Should we have a separate aio package? (or a or async (which isn't allowed)
  2. b_<plugin> versus
    • Some have these and some don't (integrations.b_aiosqlite, etc...)
    • Confusing with a_ (a implies async, b implies burr, a_b implies async Burr I suppose?)
    • Done initially to disambiguate import names, although not consistently
  3. plugin -> package extension name configuration
    • No clear mapping here
    • Makes it really hard to understand what needs to be installed
    • Maybe we have live checks -- should probably consistently be using this tool

Describe the solution you'd like

  1. Come up with best practices
  2. Document/ensure them, make any migrations needed
  3. Figure out how to keep it consistent in the future (open-ended)

Describe alternatives you've considered
Chaos :)

Additional context
Add any other context or screenshots about the feature request here.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions