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

export IncludeEnum as it is required by #get and #query #1167

Merged
merged 1 commit into from
Sep 21, 2023
Merged

export IncludeEnum as it is required by #get and #query #1167

merged 1 commit into from
Sep 21, 2023

Conversation

calvintwr
Copy link
Contributor

Description of changes

The IncludeEnum enum is not exported, cause lint errors when using .get or .query, as follows:

const result = await collection.query({
    queryTexts: [query],
    // THIS LINE WILL PRODUCE LINT ERROR as it needs IncludeEnum.Distances etc.
    include: ['distances', 'documents', 'metadatas'],
    nResults: 2,
})

Test plan

Nil

Documentation Changes

Nil

@github-actions
Copy link

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 (Readbility, Modularity, Intuitiveness)

Copy link
Contributor

@jeffchuber jeffchuber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@HammadB HammadB merged commit 35991bf into chroma-core:main Sep 21, 2023
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