docs: adding field descriptions to predefined text document

[punndcoder28]

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

[codecov]

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.

[punndcoder28]

@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

[JoanFM]

Hello @punndcoder28 ,

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

[punndcoder28]

Sorry for that. The commits should be signed off now

[punndcoder28]

@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?

[JoanFM]

@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

[JohannesMessner]

Thanks for the PR! :)

[JoanFM]

A minor change

[JoanFM]

better have a single vector in the example

[JoanFM]

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

[JoanFM]

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