docs: adding field descriptions to predefined audio document by punndcoder28 · Pull Request #1774 · docarray/docarray · GitHub
Skip to content

docs: adding field descriptions to predefined audio document#1774

Merged
JoanFM merged 1 commit intodocarray:mainfrom
punndcoder28:docs_adding_field_description_audio_document
Sep 14, 2023
Merged

docs: adding field descriptions to predefined audio document#1774
JoanFM merged 1 commit intodocarray:mainfrom
punndcoder28:docs_adding_field_description_audio_document

Conversation

@punndcoder28
Copy link
Copy Markdown
Contributor

@punndcoder28 punndcoder28 commented Sep 5, 2023

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

@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_audio_document branch from 106b51c to be3e2ee Compare September 5, 2023 17:18
Comment thread docarray/documents/audio.py
Comment thread docarray/documents/audio.py
@punndcoder28 punndcoder28 marked this pull request as ready for review September 5, 2023 17:20
@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 5, 2023

Comment thread docarray/documents/audio.py Outdated
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_audio_document branch from be3e2ee to 8a7538d Compare September 6, 2023 17:59
@punndcoder28 punndcoder28 requested a review from JoanFM September 6, 2023 17:59
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_audio_document branch 2 times, most recently from f47ba11 to f9a1871 Compare September 8, 2023 17:04
Comment thread docarray/documents/audio.py Outdated
Comment thread docarray/documents/audio.py Outdated
Comment thread docarray/documents/audio.py Outdated
Comment thread docarray/documents/audio.py Outdated
Comment thread docarray/documents/audio.py Outdated
@JoanFM
Copy link
Copy Markdown
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_audio_document branch 2 times, most recently from bd495f4 to ad71930 Compare September 14, 2023 16:51
@punndcoder28
Copy link
Copy Markdown
Contributor Author

@punndcoder28 punndcoder28 requested a review from JoanFM September 14, 2023 16:52
Comment thread docarray/documents/audio.py Outdated
Signed-off-by: punndcoder28 <puneethk.2899@gmail.com>
@punndcoder28 punndcoder28 force-pushed the docs_adding_field_description_audio_document branch from ad71930 to c3097df Compare September 14, 2023 17:32
@punndcoder28 punndcoder28 requested a review from JoanFM September 14, 2023 17:32
@JoanFM JoanFM merged commit 35d2138 into docarray:main Sep 14, 2023
@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.

2 participants