Skip to content

Conversation

yoonghm
Copy link

@yoonghm yoonghm commented Aug 30, 2025

Missing {% TabbedCodeBlock %} and {% Tab label="python" %}

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

Migration plan

Are there any migrations, or any forwards/backwards compatibility changes needed in order to make sure this change deploys reliably?

Observability plan

What is the plan to instrument and monitor this change?

Documentation Changes

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

Missing {% TabbedCodeBlock %} and {% Tab label="python" %}
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
Contributor

This PR updates the documentation file manage-collections.md by inserting the missing Markdoc tab components for a Python code snippet. Specifically, it wraps a previously untagged Python code sample with {% TabbedCodeBlock %} and {% Tab label="python" %} tags. These changes improve documentation structure and code sample clarity but do not alter any product functionality.

This summary was automatically generated by @propel-code-bot

@@ -82,6 +82,9 @@ collection = client.create_collection(

Instead of having Chroma embed documents, you can also provide embeddings directly when [adding data](./add-data) to a collection. In this case, your collection will not have an embedding function set, and you will be responsible for providing embeddings directly when adding data and querying.

Copy link
Contributor

Choose a reason for hiding this comment

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

[Documentation]

The TabbedCodeBlock and Tab tags are opened but never closed. Add {% /Tab %} and {% /TabbedCodeBlock %} after the code block to prevent malformed Markdown/Markdoc rendering.

@kylediaz
Copy link
Contributor

Hi 👋 Thanks for contributing!
Screenshot 2025-08-29 at 10 57 26 PM

I think your change breaks the website. Did you get it working on your machine?

I think the second codeblock you tried to fix actually shouldn't be there. If you'd like you could remove it!
Screenshot 2025-08-29 at 10 58 09 PM

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