Skip to content

docs: improve filtering docstrings #1762

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

Merged
merged 3 commits into from
Aug 24, 2023
Merged

docs: improve filtering docstrings #1762

merged 3 commits into from
Aug 24, 2023

Conversation

JoanFM
Copy link
Member

@JoanFM JoanFM commented Aug 24, 2023

As per suggestion in #1749, Some better documentation about the syntax of the filtering query is required

@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.68% ⚠️

Comparison is base (2af8a0c) 84.99% compared to head (744443d) 84.31%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1762      +/-   ##
==========================================
- Coverage   84.99%   84.31%   -0.68%     
==========================================
  Files         134      134              
  Lines        8845     8845              
==========================================
- Hits         7518     7458      -60     
- Misses       1327     1387      +60     
Flag Coverage Δ
docarray 84.31% <ø> (-0.68%) ⬇️

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

Files Changed Coverage Δ
docarray/utils/filter.py 100.00% <ø> (ø)

... and 2 files with indirect coverage changes

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

Signed-off-by: Joan Fontanals Martinez <[email protected]>
@JoanFM JoanFM requested a review from scott-martens August 24, 2023 06:52
Co-authored-by: Scott Martens <[email protected]>
Signed-off-by: Joan Fontanals <[email protected]>
Copy link
Contributor

@scott-martens scott-martens left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Joan Fontanals Martinez <[email protected]>
@github-actions github-actions bot added size/m and removed size/xs labels Aug 24, 2023
@github-actions
Copy link

📝 Docs are deployed on https://ft-docstring-filter--jina-docs.netlify.app 🎉

@JoanFM JoanFM merged commit 61bf9c7 into main Aug 24, 2023
@JoanFM JoanFM deleted the docstring-filter branch August 24, 2023 07:55
@JoanFM JoanFM mentioned this pull request Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants