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(common): in-depth guide for StatusOr #10555

Merged

Conversation

coryan
Copy link
Contributor

@coryan coryan commented Jan 11, 2023

Part of the work for #10157


This change is Reviewable

@codecov
Copy link

codecov bot commented Jan 11, 2023

Codecov Report

Base: 94.01% // Head: 94.00% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (d1bc43d) compared to base (7d0af69).
Patch has no changes to coverable lines.

❗ Current head d1bc43d differs from pull request most recent head c94c433. Consider uploading reports for the commit c94c433 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10555      +/-   ##
==========================================
- Coverage   94.01%   94.00%   -0.01%     
==========================================
  Files        1643     1643              
  Lines      147690   147694       +4     
==========================================
- Hits       138848   138845       -3     
- Misses       8842     8849       +7     
Impacted Files Coverage Δ
google/cloud/status.h 100.00% <ø> (ø)
...ogle/cloud/spanner/testing/pick_random_instance.cc 84.21% <0.00%> (-7.90%) ⬇️
google/cloud/pubsub/subscriber_connection_test.cc 98.78% <0.00%> (-1.22%) ⬇️
...cloud/pubsub/internal/subscription_session_test.cc 97.82% <0.00%> (-0.67%) ⬇️
google/cloud/internal/timer_queue.cc 98.46% <0.00%> (-0.21%) ⬇️
google/cloud/pubsub/samples/samples.cc 87.92% <0.00%> (-0.08%) ⬇️
google/cloud/internal/timer_queue.h 100.00% <0.00%> (ø)
google/cloud/internal/timer_queue_test.cc 100.00% <0.00%> (ø)
...le/cloud/storage/internal/curl_download_request.cc 89.63% <0.00%> (+0.33%) ⬆️
google/cloud/internal/async_rpc_details.h 100.00% <0.00%> (+5.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.

@coryan coryan force-pushed the doc-common-error-handling-documentation branch from 9930dad to d1bc43d Compare January 12, 2023 00:52
@coryan coryan marked this pull request as ready for review January 12, 2023 02:02
@coryan coryan requested a review from a team as a code owner January 12, 2023 02:02

## Futures

Some functions return a "future" ([future<T>]). This objects represent a value
Copy link
Contributor

Choose a reason for hiding this comment

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

s/This/These/

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

google/cloud/samples/samples.cc Show resolved Hide resolved
## Overview

In general, the `google-cloud-cpp` libraries return a [StatusOr<T>] if a
function many fail and needs to signal an error. `StatusOr<T>` is an "outcome",
Copy link
Contributor

Choose a reason for hiding this comment

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

s/many/may/

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

@coryan coryan force-pushed the doc-common-error-handling-documentation branch from d1bc43d to c94c433 Compare January 12, 2023 15:42
@coryan coryan merged commit 8847ffa into googleapis:main Jan 12, 2023
@coryan coryan deleted the doc-common-error-handling-documentation branch January 12, 2023 18:20
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.

3 participants