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

doc(bigtable): create page for configuration options #10197

Merged

Conversation

coryan
Copy link
Member

@coryan coryan commented Nov 8, 2022

This change is Reviewable

@product-auto-label product-auto-label bot added the api: bigtable Issues related to the Bigtable API. label Nov 8, 2022
@google-cloud-cpp-bot
Copy link
Collaborator

Google Cloud Build Logs
For commit: 38b7fb107e83cee77fed78b0c4c53469fcba9b6f

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

@coryan coryan marked this pull request as ready for review November 8, 2022 01:13
@coryan coryan requested a review from a team as a code owner November 8, 2022 01:13
@codecov
Copy link

codecov bot commented Nov 8, 2022

Codecov Report

Base: 93.98% // Head: 93.97% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (38b7fb1) compared to base (fe8f7eb).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10197      +/-   ##
==========================================
- Coverage   93.98%   93.97%   -0.01%     
==========================================
  Files        1531     1531              
  Lines      141068   141068              
==========================================
- Hits       132584   132573      -11     
- Misses       8484     8495      +11     
Impacted Files Coverage Δ
...bigtable/examples/bigtable_hello_instance_admin.cc 81.00% <0.00%> (-2.00%) ⬇️
...cloud/pubsub/internal/subscription_session_test.cc 97.82% <0.00%> (-1.18%) ⬇️
...ud/spanner/integration_tests/client_stress_test.cc 84.21% <0.00%> (-0.66%) ⬇️
...le/cloud/internal/default_completion_queue_impl.cc 96.59% <0.00%> (-0.57%) ⬇️
google/cloud/storage/parallel_upload.cc 98.28% <0.00%> (-0.35%) ⬇️
google/cloud/completion_queue_test.cc 97.13% <0.00%> (-0.20%) ⬇️
google/cloud/pubsub/samples/samples.cc 90.70% <0.00%> (-0.08%) ⬇️
...le/cloud/storage/internal/curl_download_request.cc 89.29% <0.00%> (+1.00%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@dbolduc dbolduc left a comment

Choose a reason for hiding this comment

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

Should we be adding the OptionList<>s? Have they fallen out of favor?

* Option to configure the retry policy used by `Table`.
*
* @ingroup bigtable-options
*/
struct DataRetryPolicyOption {
Copy link
Member

Choose a reason for hiding this comment

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

every generated service has an equivalent of this option too. Will they all get these *-options.dox?

Copy link
Member Author

Choose a reason for hiding this comment

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

I would like to, yes, but I did the hand-crafted libraries first.

@coryan
Copy link
Member Author

coryan commented Nov 8, 2022

Should we be adding the OptionList<>s? Have they fallen out of favor?

I am not sure why customers would care for them. AFAIK they are only used to implement some checks, and probably should not be in the public namespace. I have no idea if we should remove them, move them to *_internal. Until we decide, we should leave them undocumented (created #10206) to track.

Copy link
Member

@dbolduc dbolduc left a comment

Choose a reason for hiding this comment

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

Ack. I think the OptionList<>s were also added for discoverability of Options.

* The optional @p options argument may be used to configure aspects of the
* returned `AccessApprovalConnection`. Expected options are any of the types in
* the following option lists:
*
* - `google::cloud::CommonOptionList`
* - `google::cloud::GrpcOptionList`
* - `google::cloud::UnifiedCredentialsOptionList`
* - `google::cloud::accessapproval::AccessApprovalPolicyOptionList`

But these doxygen ref groups probably do a better job.

@coryan coryan enabled auto-merge (squash) November 8, 2022 15:19
@coryan coryan merged commit 733cea0 into googleapis:main Nov 8, 2022
@coryan coryan deleted the doc-bigtable-create-page-for-options branch November 8, 2022 15:43
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 Bigtable API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants