Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

docs: improve filtering docstrings - #1762

Merged
JoanFM merged 3 commits into
mainfrom
docstring-filter
Aug 24, 2023
Merged

JoanFM merged 3 commits into
mainfrom
docstring-filter

Conversation

@JoanFM

@JoanFM JoanFM commented Aug 24, 2023

Copy link
Copy Markdown
Member

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

@codecov

codecov Bot commented Aug 24, 2023

Copy link
Copy Markdown

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 <joan.martinez@jina.ai>
@JoanFM
JoanFM requested a review from scott-martens August 24, 2023 06:52
Comment thread docarray/utils/filter.py Outdated
Co-authored-by: Scott Martens <70647348+scott-martens@users.noreply.github.com>
Signed-off-by: Joan Fontanals <jfontanalsmartinez@gmail.com>

@scott-martens scott-martens left a comment

Copy link
Copy Markdown
Contributor

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 <joan.martinez@jina.ai>
@github-actions github-actions Bot added size/m and removed size/xs labels Aug 24, 2023
@github-actions

Copy link
Copy Markdown

📝 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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants