DR-98 docstrings and docs repo by daveatweaviate · Pull Request #827 · weaviate/weaviate-python-client

daveatweaviate · 2024-01-30T19:21:01Z

Updates a couple of the error message links
Updates some of the outdated docs pages on the repo

databyjp · 2024-01-30T21:41:37Z

CONTRIBUTING.md

+To activate your virtual environment, run `source .venv/bin/activate`.

-To run local instance of Weaviate, we recommend using Docker (see https://weaviate.io/developers/weaviate/installation/docker-compose).
+The newest client versions sometimes require upcoming Weaviate core features. We recommend using Docker (see https://weaviate.io/developers/weaviate/installation/docker-compose) to run a local instance of the latest Weaviate core for client development.


Upcoming sounds unreleased

Yes, the core and client have been developing, with inter-dependencies, ahead of the released server core.

My point is that I don't think client features get released without a corresponding server version. @dirkkul pls lmk if that's incorrect.

this is contributing, so for potential developers. I think it makes sense to have it in

Then we should maybe point them towards running a dev setup directly.

dirkkul · 2024-01-31T03:31:59Z

weaviate/error_msgs.py

-    "https://weaviate.io/developers/weaviate/current/restful-api-references/"
-    "batch.html#example-request-1"
+    " `client.batch.configure()` to an integer value . See also: "
+    "https://weaviate.io/developers/weaviate/client-libraries/python#batching"


this is a v3 warning - I'd leave it like it is

dirkkul · 2024-01-31T03:32:09Z

weaviate/warnings.py

            multi-threading. Setting `batch_size` in `client.batch.configure()`  to an int value will enabled automatic
-            batching. See:
-            https://weaviate.io/developers/weaviate/current/restful-api-references/batch.html#example-request-1""",
+            batching. See:https://weaviate.io/developers/weaviate/client-libraries/python#batching""",


same, also old v3 warning

dirkkul · 2024-01-31T03:32:21Z

weaviate/warnings.py

            message="""Dep006: You are using the `client.batch()` method, which will be removed in the next major release.
            Please instead use the `client.batch.configure()` method to configure your batch and `client.batch` to enter the context manager.
-            See https://weaviate.io/developers/weaviate/client-libraries/python for details.""",
+            See https://weaviate.io/developers/weaviate/client-libraries/python#batching for details.""",


…t into DR-98-links-in-docstrings-and-repo-docs

daveatweaviate

@dirkkul @databyjp thanks for the feedback, this is ready for another look

daveatweaviate · 2024-01-31T15:49:19Z

CONTRIBUTING.md

+To activate your virtual environment, run `source .venv/bin/activate`.

-To run local instance of Weaviate, we recommend using Docker (see https://weaviate.io/developers/weaviate/installation/docker-compose).
+The newest client versions sometimes require upcoming Weaviate core features. We recommend using Docker (see https://weaviate.io/developers/weaviate/installation/docker-compose) to run a local instance of the latest Weaviate core for client development.


daveatweaviate · 2024-01-31T15:50:04Z

weaviate/error_msgs.py

-    "https://weaviate.io/developers/weaviate/current/restful-api-references/"
-    "batch.html#example-request-1"
+    " `client.batch.configure()` to an integer value . See also: "
+    "https://weaviate.io/developers/weaviate/client-libraries/python#batching"


daveatweaviate · 2024-01-31T15:51:14Z

weaviate/warnings.py

            multi-threading. Setting `batch_size` in `client.batch.configure()`  to an int value will enabled automatic
-            batching. See:
-            https://weaviate.io/developers/weaviate/current/restful-api-references/batch.html#example-request-1""",
+            batching. See:https://weaviate.io/developers/weaviate/client-libraries/python#batching""",


daveatweaviate · 2024-01-31T15:52:25Z

weaviate/warnings.py

            message="""Dep006: You are using the `client.batch()` method, which will be removed in the next major release.
            Please instead use the `client.batch.configure()` method to configure your batch and `client.batch` to enter the context manager.
-            See https://weaviate.io/developers/weaviate/client-libraries/python for details.""",
+            See https://weaviate.io/developers/weaviate/client-libraries/python#batching for details.""",


dirkkul

Thanks @daveatweaviate!

We merged the beta branch to main in the mean time, could you change the target? In case the PR is then borked: You can branch of main, cherry-pick, the commits from here and make a new PR, I'Ll merge that right away.

daveatweaviate · 2024-02-01T16:17:13Z

Closing - base branch changed. New PR

Merge conflict

91f2ca7

daveatweaviate marked this pull request as draft January 30, 2024 19:21

staging review

bea1209

daveatweaviate marked this pull request as ready for review January 30, 2024 19:27

daveatweaviate requested review from databyjp and dirkkul January 30, 2024 19:27

staging review

1b35ce4

databyjp reviewed Jan 30, 2024

View reviewed changes

dirkkul reviewed Jan 31, 2024

View reviewed changes

daveatweaviate added 2 commits January 31, 2024 10:38

Merge branch 'beta/v4.0' of github.com:weaviate/weaviate-python-clien…

e4f5051

…t into DR-98-links-in-docstrings-and-repo-docs

Review feedback

b4f61eb

daveatweaviate commented Jan 31, 2024

View reviewed changes

dirkkul approved these changes Feb 1, 2024

View reviewed changes

daveatweaviate changed the base branch from beta/v4.0 to main February 1, 2024 14:25

daveatweaviate requested a review from a team as a code owner February 1, 2024 14:25

daveatweaviate changed the base branch from main to beta/v4.0 February 1, 2024 14:26

dirkkul approved these changes Feb 1, 2024

View reviewed changes

daveatweaviate mentioned this pull request Feb 1, 2024

DR-98 strings update on new branch #845

Merged

daveatweaviate closed this Feb 1, 2024

Conversation

daveatweaviate commented Jan 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daveatweaviate Jan 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daveatweaviate left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dirkkul left a comment

Choose a reason for hiding this comment

Uh oh!

daveatweaviate commented Feb 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

daveatweaviate commented Jan 30, 2024 •

edited

Loading

daveatweaviate Jan 31, 2024 •

edited

Loading