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

docs: adding field descriptions to predefined image document #1772

Merged

Conversation

punndcoder28
Copy link
Contributor

  • Adds field descriptions and example usage of each field for the predefined Image document

@codecov
Copy link

codecov bot commented Sep 4, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.13% 🎉

Comparison is base (715252a) 83.73% compared to head (794da80) 83.87%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1772      +/-   ##
==========================================
+ Coverage   83.73%   83.87%   +0.13%     
==========================================
  Files         136      136              
  Lines        9040     9041       +1     
==========================================
+ Hits         7570     7583      +13     
+ Misses       1470     1458      -12     
Flag Coverage Δ
docarray 83.87% <100.00%> (+0.13%) ⬆️

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

Files Changed Coverage Δ
docarray/documents/image.py 89.28% <100.00%> (+0.39%) ⬆️

... and 16 files with indirect coverage changes

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

@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch 2 times, most recently from fb2edac to 1766ca5 Compare September 4, 2023 17:00
@punndcoder28 punndcoder28 marked this pull request as ready for review September 4, 2023 17:10
docarray/documents/image.py Outdated Show resolved Hide resolved
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch 2 times, most recently from 0875819 to 9be3411 Compare September 5, 2023 17:09
docarray/documents/image.py Outdated Show resolved Hide resolved
docarray/documents/image.py Outdated Show resolved Hide resolved
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch from 9be3411 to 0511713 Compare September 6, 2023 17:54
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch 2 times, most recently from 008c51f to 0eb7502 Compare September 6, 2023 18:16
docarray/documents/image.py Outdated Show resolved Hide resolved
@JoanFM
Copy link
Member

JoanFM commented Sep 14, 2023

To resolve the conflicts, make sure to add None as the default value for the Optional fields.

Signed-off-by: punndcoder28 <puneethk.2899@gmail.com>
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch from 0eb7502 to 9e21a5a Compare September 14, 2023 17:04
docarray/documents/image.py Outdated Show resolved Hide resolved
docarray/documents/image.py Outdated Show resolved Hide resolved
docarray/documents/image.py Outdated Show resolved Hide resolved
docarray/documents/image.py Outdated Show resolved Hide resolved
docarray/documents/image.py Outdated Show resolved Hide resolved
@punndcoder28
Copy link
Contributor Author

Weird, must've gotten added while rebasing the changes. Will fix the quotes

@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch 2 times, most recently from 9f82327 to 061510a Compare September 14, 2023 17:24
Signed-off-by: punndcoder28 <puneethk.2899@gmail.com>
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_image_document branch from 061510a to 794da80 Compare September 14, 2023 17:27
@JoanFM JoanFM merged commit 441db26 into docarray:main Sep 14, 2023
36 of 40 checks passed
@JoanFM JoanFM mentioned this pull request Oct 2, 2023
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.

None yet

2 participants