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

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

Open
elijahbenizzy opened this issue Jan 15, 2025 · 0 comments

Comments

@elijahbenizzy
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant