Skip to content
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.

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

docs: fix description of timeout config for WeaviateDocumentStore #7380

Conversation

baldpanda
Copy link

Related Issues

Proposed Changes:

Updating documentation for the timeout_config for the WeaviateDocumentStore. It is currently (retries, time out seconds) which is inconsistent with the Weaviate client documentation of (connect timeout, read timeout). Updating it to this

How did you test it?

Verified manually that the parameter for the connect_timeout is not a retry parameter and is the connection timeout for the Weaviate DB.

Notes for the reviewer

Weaviate Client documentation: https://weaviate-python-client.readthedocs.io/en/stable/weaviate.html#weaviate.Client.timeout_config

Checklist

@baldpanda baldpanda requested a review from a team as a code owner March 19, 2024 09:24
@baldpanda baldpanda requested review from silvanocerza and removed request for a team March 19, 2024 09:24
@CLAassistant
Copy link

CLAassistant commented Mar 19, 2024

CLA assistant check
All committers have signed the CLA.

@anakin87 anakin87 requested review from anakin87 and removed request for silvanocerza March 19, 2024 09:26
@anakin87 anakin87 added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Mar 19, 2024
Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

Looks good!

Thank you for this contribution. 🙏

@anakin87 anakin87 merged commit f389dcf into deepset-ai:v1.x Mar 19, 2024
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-for-release-notes PRs with this flag won't be included in the release notes. topic:document_store topic:weaviate type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants