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

[ENH] Configuration UX #2437

Closed
wants to merge 1 commit into from

Conversation

atroyn
Copy link
Contributor

@atroyn atroyn commented Jul 2, 2024

Description of changes

This PR creates a nicer user-facing constructor for collection configurations, wrapping the existing internal representation. This is basically hacky constructor polymorphism, everything internal remains the same.

Test plan

CI passes.

Documentation Changes

No changes.

Copy link

github-actions bot commented Jul 2, 2024

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

Copy link

github-actions bot commented Jul 2, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link
Contributor Author

atroyn commented Jul 2, 2024

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @atroyn and the rest of your teammates on Graphite Graphite

@atroyn atroyn changed the title Convenience constructors [ENH] Configuration UX Jul 2, 2024
@atroyn atroyn force-pushed the anton/configuration-ux branch 3 times, most recently from 6ff9475 to f53a3e3 Compare July 2, 2024 16:06
@atroyn atroyn force-pushed the anton/collection_migrations branch from e796bfc to 4adbfb9 Compare July 2, 2024 17:26
@atroyn atroyn force-pushed the anton/collection_migrations branch from 4adbfb9 to 2a36bc0 Compare July 2, 2024 18:19
@atroyn atroyn marked this pull request as ready for review July 2, 2024 20:22
@atroyn atroyn requested review from codetheweb and HammadB July 2, 2024 20:22
@atroyn atroyn force-pushed the anton/collection_migrations branch from e0233d2 to 209e1f6 Compare July 8, 2024 19:04
@atroyn atroyn closed this Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants