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

chore(docs): add preview docstrings to v3 client #926

Merged
merged 68 commits into from
Feb 7, 2024
Merged

Conversation

daniel-sanche
Copy link
Contributor

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:

  • the main README, to describe the new client, and its current experimental status
  • to the main class docstring for BigtableDataClientAsync
  • to each method rpc

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

daniel-sanche and others added 30 commits March 14, 2023 15:47
@daniel-sanche daniel-sanche requested review from a team as code owners January 27, 2024 00:45
@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: bigtable Issues related to the googleapis/python-bigtable API. labels Jan 27, 2024
README.rst Outdated
----------------------------------

`v2.23.0` includes a preview release of a new data client, accessible at `google.cloud.bigtable.data.BigtableDataClientAsync`.

Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor

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!

Copy link
Contributor

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

Copy link
Contributor Author

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

@mutianf
Copy link
Contributor

mutianf commented Jan 31, 2024

Let's also add the feedback email cbt-python-client-v3-feedback to the readme!

Base automatically changed from merge_v3 to main February 5, 2024 18:33
@daniel-sanche daniel-sanche requested a review from a team as a code owner February 5, 2024 18:33
@daniel-sanche daniel-sanche changed the title chore(docs): add alpha docstrings to v3 client chore(docs): add preview docstrings to v3 client Feb 5, 2024
@daniel-sanche daniel-sanche merged commit 3393f8c into main Feb 7, 2024
25 of 32 checks passed
@daniel-sanche daniel-sanche deleted the document_v3 branch February 7, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigtable Issues related to the googleapis/python-bigtable API. size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants