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

docs(common): better exception descriptions #11705

Merged

Conversation

coryan
Copy link
Contributor

@coryan coryan commented May 23, 2023

This change is Reviewable

@@ -176,11 +176,21 @@ class StatusOr final {
*
* @param rhs the value used to initialize the object.
*
* @throws only if `T`'s move constructor throws.
* @throws ... If `T` move constructor throws.
Copy link
Member

Choose a reason for hiding this comment

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

Q: why is the apostrophe after backtick bad? Is it only bad in the @throws block?

FYI:

dbolduc@dbolduc-glaptop:~/code/git/google-cloud-cpp$ grep -rl "\`'" $(git ls-files -- *.h)
docfx/yaml_context.h
google/cloud/bigtable/mutation_batcher.h
google/cloud/mocks/mock_stream_range.h
google/cloud/monitoring/v3/service_monitoring_client.h
google/cloud/options.h
google/cloud/pubsub/blocking_publisher_connection.h
google/cloud/pubsub/internal/session_shutdown_manager.h
google/cloud/pubsub/publisher_connection.h
google/cloud/pubsub/subscriber_connection.h
google/cloud/pubsub/topic_admin_connection.h
google/cloud/pubsublite/internal/alarm_registry_impl.h
google/cloud/spanner/connection.h
google/cloud/spanner/value.h
google/cloud/status_or.h

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

@codecov
Copy link

codecov bot commented May 23, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (80a8b19) 83.02% compared to head (f40ebd3) 83.02%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11705      +/-   ##
==========================================
- Coverage   83.02%   83.02%   -0.01%     
==========================================
  Files        1827     1827              
  Lines      164734   164734              
==========================================
- Hits       136765   136764       -1     
- Misses      27969    27970       +1     
Impacted Files Coverage Δ
google/cloud/future_generic.h 100.00% <ø> (ø)
google/cloud/future_void.h 100.00% <ø> (ø)
google/cloud/internal/future_impl.h 94.93% <ø> (ø)
google/cloud/status_or.h 100.00% <ø> (ø)

... and 6 files with indirect coverage changes

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

@coryan coryan force-pushed the docs-common-better-exception-descriptions branch from d79d6c8 to f40ebd3 Compare May 23, 2023 16:25
@coryan coryan marked this pull request as ready for review May 23, 2023 17:10
@coryan coryan requested a review from a team as a code owner May 23, 2023 17:10
@coryan coryan enabled auto-merge (squash) May 23, 2023 17:10
@coryan coryan merged commit 96f2b47 into googleapis:main May 23, 2023
@coryan coryan deleted the docs-common-better-exception-descriptions branch May 23, 2023 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants