-
Notifications
You must be signed in to change notification settings - Fork 58
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
chore(docs): add preview docstrings to v3 client #926
Conversation
This reverts commit c3ed5aa.
README.rst
Outdated
---------------------------------- | ||
|
||
`v2.23.0` includes a preview release of a new data client, accessible at `google.cloud.bigtable.data.BigtableDataClientAsync`. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can point this README to a new README file under _async, and provide some examples there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point about the secondary README, I added another one in the /data
folder
But we discussed offline adding the usage examples later, so for now it just includes some of the same content as this one. Let me know what you think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup let's update examples later!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we move this section to the top of the document? (or at least above HappyBase) I don't think we want to advertise happybase anymore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, moved to the top and removed the happybase section
I also added feedback links
Let's also add the feedback email |
This PR adds a notice to the new client in the experiemntal v3 branch, in prep for merging the branch into main. Warnings are added in the following places:
Let me know if you have thoughts on the wording of these notices, or if there are other places we should be introducing the new client