Skip to content

Quilt3 search doc#4488

Merged
nl0 merged 3 commits intomasterfrom
quilt3-search-doc
Aug 26, 2025
Merged

Quilt3 search doc#4488
nl0 merged 3 commits intomasterfrom
quilt3-search-doc

Conversation

@nl0
Copy link
Member

@nl0 nl0 commented Aug 25, 2025

This pull request improves the documentation for the search method in both the Python API and the user documentation. It adds direct links to the Quilt Search documentation, making it easier for users to find information about index schemas and search examples.

Documentation improvements:

  • Added a reference and link to the Quilt Search documentation for index schemas and search examples in the docstrings of the search method in api/python/quilt3/api.py and api/python/quilt3/bucket.py.
  • Updated the API reference documentation in docs/api-reference/Bucket.md and docs/api-reference/api.md to include a link to the Quilt Search documentation for further guidance on search queries.

@nl0
Copy link
Member Author

nl0 commented Aug 25, 2025

@kevinemoore did you mean smth like this?

@codecov
Copy link

codecov bot commented Aug 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37.90%. Comparing base (357049b) to head (e060b56).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #4488    +/-   ##
========================================
  Coverage   37.90%   37.90%            
========================================
  Files         826      826            
  Lines       36460    36460            
  Branches     5972     5972            
========================================
  Hits        13819    13819            
- Misses      21413    22120   +707     
+ Partials     1228      521   -707     
Flag Coverage Δ
api-python 91.44% <ø> (ø)
catalog 17.78% <ø> (ø)
lambda 92.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nl0 nl0 mentioned this pull request Aug 25, 2025
Copy link
Contributor

@kevinemoore kevinemoore left a comment

Choose a reason for hiding this comment

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

Looks good. It's a big help to include a link to the ES schemas from the python search API docs.

@nl0 nl0 marked this pull request as ready for review August 26, 2025 09:58
@nl0 nl0 added this pull request to the merge queue Aug 26, 2025
Merged via the queue into master with commit 1e34086 Aug 26, 2025
38 of 39 checks passed
@nl0 nl0 deleted the quilt3-search-doc branch August 26, 2025 10:06
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