Skip to content

docs: adding field descriptions to predefined video document #1775

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 15, 2023
Merged

docs: adding field descriptions to predefined video document #1775

merged 2 commits into from
Sep 15, 2023

Conversation

punndcoder28
Copy link
Contributor

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

@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_video_document branch from eff956a to c3d4930 Compare September 5, 2023 17:52
punndcoder28
punndcoder28 commented Sep 5, 2023
View reviewed changes
punndcoder28
punndcoder28 commented Sep 5, 2023
View reviewed changes
punndcoder28
punndcoder28 commented Sep 5, 2023
View reviewed changes
@punndcoder28 punndcoder28 marked this pull request as ready for review September 5, 2023 17:54
@codecov
Copy link

codecov bot commented Sep 5, 2023 •
edited
Loading

Codecov Report

Patch coverage: 100.00% and project coverage change: -3.66% ⚠️

Comparison is base (715252a) 83.73% compared to head (c207785) 80.08%.
Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1775      +/-   ##
==========================================
- Coverage   83.73%   80.08%   -3.66%     
==========================================
  Files         136      136              
  Lines        9040     9044       +4     
==========================================
- Hits         7570     7243     -327     
- Misses       1470     1801     +331
Flag Coverage Δ
docarray 80.08% <100.00%> (-3.66%) ⬇️

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

Files Changed Coverage Δ
docarray/documents/video.py 90.00% <100.00%> (-3.11%) ⬇️

... and 20 files with indirect coverage changes

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

samsja
samsja reviewed Sep 6, 2023
View reviewed changes
samsja
samsja reviewed Sep 6, 2023
View reviewed changes
samsja
samsja reviewed Sep 6, 2023
View reviewed changes
samsja
samsja reviewed Sep 6, 2023
View reviewed changes
JoanFM
JoanFM requested changes Sep 6, 2023
View reviewed changes
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_video_document branch from c3d4930 to 364359e Compare September 6, 2023 18:08
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_video_document branch from 364359e to 95ba53e Compare September 6, 2023 18:12
JoanFM
JoanFM requested changes Sep 14, 2023
View reviewed changes
@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.

@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_video_document branch from 95ba53e to f2b3040 Compare September 14, 2023 16:56
@punndcoder28 punndcoder28 requested a review from JoanFM September 14, 2023 16:57
JoanFM
JoanFM requested changes Sep 14, 2023
View reviewed changes
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_video_document branch from f2b3040 to e981291 Compare September 14, 2023 17:34
@punndcoder28 punndcoder28 requested a review from JoanFM September 14, 2023 17:34
JoanFM
JoanFM requested changes Sep 14, 2023
View reviewed changes
JoanFM
JoanFM requested changes Sep 15, 2023
View reviewed changes
@JoanFM JoanFM merged commit 4ef4939 into docarray:main Sep 15, 2023
@JoanFM JoanFM mentioned this pull request Oct 2, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoanFM JoanFM JoanFM requested changes

@samsja samsja Awaiting requested review from samsja

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@punndcoder28 @JoanFM @samsja