GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — docs: adding field descriptions to predefined text document by punndcoder28 · Pull Request #1770 · docarray/docarray

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

Conversation

@punndcoder28

@punndcoder28 punndcoder28 commented Sep 1, 2023

Copy link
Copy Markdown
Contributor
  • Adds field descriptions and example usage of each field for the predefined Text

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@codecov

codecov Bot commented Sep 1, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Codecov Report

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

Comparison is base (715252a) 83.73% compared to head (2ee9c01) 83.87%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1770      +/-   ##
==========================================
+ 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/text.py 96.66% <100.00%> (+0.11%) ⬆️

... and 16 files with indirect coverage changes

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28

punndcoder28 commented Sep 1, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

@JoanFM I've added an initial implementation of the change to add a field description for attribute of Text document. Would love to hear your thoughts and more changes that are needed. Can the example attribute from Field have a multi-line example? Since for bytes I want to provide one of video or audio bytes which needs a multiple line example

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JoanFM

JoanFM commented Sep 1, 2023

Copy link
Copy Markdown
Member

Hello @punndcoder28 ,

Thanks for the contribution. However, we would need you to sign off the commit so that we can incorporate your improvements.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch from fe2cae2 to 41ee465 Compare September 1, 2023 18:04
@punndcoder28

punndcoder28 commented Sep 1, 2023

Copy link
Copy Markdown
Contributor Author

Sorry for that. The commits should be signed off now

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

JoanFM
JoanFM suggested changes Sep 4, 2023
View reviewed changes
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

punndcoder28
punndcoder28 commented Sep 4, 2023
View reviewed changes
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28
punndcoder28 requested a review from JoanFM September 4, 2023 16:46
JoanFM
JoanFM suggested changes Sep 4, 2023
View reviewed changes
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28
punndcoder28 requested a review from JoanFM September 5, 2023 17:03
@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch 2 times, most recently from 4146e00 to 213448a Compare September 5, 2023 17:09
JoanFM
JoanFM suggested changes Sep 6, 2023
View reviewed changes
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@JoanFM
JoanFM requested review from JohannesMessner and samsja September 6, 2023 11:48
@punndcoder28

punndcoder28 commented Sep 6, 2023

Copy link
Copy Markdown
Contributor Author

@JoanFM What is the correct github flow? Should I rebase and keep my commits for a PR to a single commit? Or each change should be a different commit?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch 2 times, most recently from 856b6ea to 81b7fdc Compare September 6, 2023 18:01
@punndcoder28
punndcoder28 requested a review from JoanFM September 6, 2023 18:02
@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch from 81b7fdc to 0b4f618 Compare September 6, 2023 18:19
@JoanFM

JoanFM commented Sep 6, 2023

Copy link
Copy Markdown
Member

@JoanFM What is the correct github flow? Should I rebase and keep my commits for a PR to a single commit? Or each change should be a different commit?

As you want, eventually all the commits will be squashed into a single one, so your choice

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

JohannesMessner
JohannesMessner suggested changes Sep 7, 2023
View reviewed changes

@JohannesMessner JohannesMessner left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks for the PR! :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch from 0b4f618 to f7362a6 Compare September 8, 2023 16:58
@punndcoder28
punndcoder28 requested a review from JohannesMessner September 8, 2023 16:58
JoanFM
JoanFM suggested changes Sep 14, 2023
View reviewed changes

@JoanFM JoanFM left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

A minor change

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread docarray/documents/text.py Outdated
)
embedding: Optional[AnyEmbedding] = Field(
description='Store an embedding: a vector representation of the text',
example='''[[1, 1, 1], [1, 0, 1], [0, 0, 1]]''',

@JoanFM JoanFM Sep 14, 2023

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

better have a single vector in the example

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@JoanFM

JoanFM commented Sep 14, 2023

Copy link
Copy Markdown
Member

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

samsja and punndcoder28 reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JoanFM

JoanFM commented Sep 14, 2023

Copy link
Copy Markdown
Member

Also, the embedding example can be a list and should not be actually a text

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

punndcoder28 added 2 commits September 14, 2023 22:40
@punndcoder28
docs: adding field descriptions to predefined text document
9a872cd
Signed-off-by: punndcoder28 <[email protected]>
@punndcoder28
docs: adding field descriptions to predefined text document
f1ab69f
Signed-off-by: punndcoder28 <[email protected]>
@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch from f7362a6 to 6e80337 Compare September 14, 2023 17:12
@punndcoder28
punndcoder28 requested a review from JoanFM September 14, 2023 17:13
JoanFM
JoanFM suggested changes Sep 14, 2023
View reviewed changes
Comment thread docarray/documents/text.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@punndcoder28
docs: remove bytes field example
2ee9c01
Signed-off-by: punndcoder28 <[email protected]>
@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_text_document branch from 6e80337 to 2ee9c01 Compare September 14, 2023 17:16
@punndcoder28
punndcoder28 requested a review from JoanFM September 14, 2023 17:25
JoanFM
JoanFM approved these changes Sep 14, 2023
View reviewed changes
@JoanFM
JoanFM merged commit 68cc142 into docarray:main Sep 14, 2023
@JoanFM JoanFM mentioned this pull request Oct 2, 2023
Release Notes #1817
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@samsja samsja Awaiting requested review from samsja
@JohannesMessner JohannesMessner Awaiting requested review from JohannesMessner
1 more reviewer
@JoanFM JoanFM JoanFM approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@punndcoder28 @JoanFM @JohannesMessner @samsja
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.