Skip to content

Fix deprecation warning in docstrings for legacy auth cred classes #1224

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix deprecation warning in docstrings for legacy auth cred classes #1224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions weaviate/auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,10 @@ def bearer_token(

# required to ease v3 -> v4 transition
AuthApiKey = _APIKey
"""@deprecated; use wvc.Auth.api_key() instead."""
"""@deprecated; use wvc.init.Auth.api_key() instead."""
Copy link
Contributor

Choose a reason for hiding this comment

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

Propose explicitly suggesting weaviate.classes.init.Auth.xxx wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment for all other changes too

AuthBearerToken = _BearerToken
"""@deprecated; use wvc.Auth.api_key() instead."""
"""@deprecated; use wvc.init.Auth.api_key() instead."""
AuthClientCredentials = _ClientCredentials
"""@deprecated; use wvc.Auth.api_key() instead."""
"""@deprecated; use wvc.init.Auth.api_key() instead."""
AuthClientPassword = _ClientPassword
"""@deprecated; use wvc.Auth.api_key() instead."""
"""@deprecated; use wvc.init.Auth.api_key() instead."""
Loading