docs(common): better exception descriptions #11705
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dbolduc
approved these changes
May 23, 2023
google/cloud/status_or.h
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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
Codecov ReportPatch coverage has no change and project coverage change:
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
☔ View full report in Codecov by Sentry. |
coryan
force-pushed
the
docs-common-better-exception-descriptions
branch
from
d79d6c8
to
f40ebd3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change is