FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: explain how to set document config by JohannesMessner · Pull Request #1773 · docarray/docarray · GitHub

/ docarray Public

docs: explain how to set document config - #1773

Merged
JohannesMessner merged 2 commits into
mainfrom
docs-document-config
Sep 5, 2023
ConversationCommits (2)ChecksFiles changed
Merged

docs: explain how to set document config#1773
JohannesMessner merged 2 commits into
mainfrom
docs-document-config

Conversation

JohannesMessner commented Sep 5, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

there is a small things that users need to be aware of when setting configs, so i am explaining that here.

TODO: small test done

docs: explain how to set document config
ea6e9bd 
Signed-off-by: Johannes Messner <messnerjo@gmail.com>
JohannesMessner marked this pull request as ready for review September 5, 2023 09:08
JohannesMessner marked this pull request as draft September 5, 2023 09:09

codecov Bot commented Sep 5, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Patch and project coverage have no change.

Comparison is base (3dc525f) 85.00% compared to head (d587a6a) 85.00%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1773   +/-   ##
=======================================
  Coverage   85.00%   85.00%           
=======================================
  Files         134      134           
  Lines        8845     8845           
=======================================
  Hits         7519     7519           
  Misses       1326     1326
Flag Coverage Δ
docarray 85.00% <ø> (ø)

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

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

test: test config subclassing
d587a6a 
Signed-off-by: Johannes Messner <messnerjo@gmail.com>
JohannesMessner marked this pull request as ready for review September 5, 2023 09:20

JohannesMessner commented Sep 5, 2023

Copy link
Copy Markdown
Member Author

@samsja what will be the effect of pydantic v2 on this?

samsja commented Sep 5, 2023

Copy link
Copy Markdown
Member

@samsja what will be the effect of pydantic v2 on this?

this way will still be compatible with pydantic v2 but pydantic will show a warning saying it is deprecated. I suggest we update the docs after the merge

deepankarm reviewed Sep 5, 2023
View reviewed changes
Comment thread docs/user_guide/representing/first_step.md


class MyDoc(BaseDoc):
class Config(BaseDoc.Config):

deepankarm Sep 5, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Minor comment. In pydantic v1, we only had to pass a class Config in the model. It didn't need to be inherited from another config class.

JohannesMessner Sep 5, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yes, in pydantic that is not needed. But we set some pydantic configs in BaseDoc, so to preserve them, inheritance is needed. We could probably find some magic way around this, but until then this is the safest option imo.

github-actions Bot commented Sep 5, 2023

Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-document-config--jina-docs.netlify.app 🎉

JohannesMessner merged commit 189ff63 into main Sep 5, 2023
JohannesMessner deleted the docs-document-config branch September 5, 2023 11:21
JoanFM mentioned this pull request Sep 7, 2023
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

samsja samsja approved these changes
JoanFM Awaiting requested review from JoanFM
+1 more reviewer
deepankarm deepankarm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area/docs area/testing size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL