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] Update documentation for generate ids changes #2775

Conversation

spikechroma
Copy link

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • ...
  • New functionality
    • ...

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Copy link

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

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
Author

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 @spikechroma and the rest of your teammates on Graphite Graphite

@spikechroma spikechroma changed the title update doc [ENH] Update documentation for generate ids changes Sep 10, 2024
@spikechroma spikechroma marked this pull request as ready for review September 10, 2024 21:06
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 7383f27 to d0cf739 Compare September 10, 2024 22:33
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from d0cf739 to e108da4 Compare September 10, 2024 23:34
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from e108da4 to 1d871fd Compare September 10, 2024 23:36
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 1d871fd to f0e9acd Compare September 10, 2024 23:59
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from f0e9acd to a65f31b Compare September 11, 2024 00:13
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from a65f31b to d55a678 Compare September 11, 2024 01:15
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from d55a678 to 065149d Compare September 11, 2024 01:40
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 065149d to 68c1f7d Compare September 11, 2024 02:36
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 1db9568 to 82c31b2 Compare September 11, 2024 05:16
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 82c31b2 to 007039e Compare September 11, 2024 05:41
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 007039e to 1a72e6b Compare September 11, 2024 06:04
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 1a72e6b to 36b17a0 Compare September 11, 2024 06:12
@atroyn atroyn self-assigned this Sep 11, 2024
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 36b17a0 to 87ba120 Compare September 11, 2024 23:52
@spikechroma spikechroma force-pushed the spike/generate_ids_js_client_update branch from 87ba120 to 499a81c Compare September 12, 2024 00:07
@atroyn atroyn force-pushed the spike/generate_ids_js_client_update branch from 499a81c to a3dc87d Compare October 2, 2024 22:04
@atroyn atroyn force-pushed the spike/generate_ids_docs_updated branch from 0427765 to a84b565 Compare October 2, 2024 22:05
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.

2 participants