docs(storage): improve signed url docs#4178
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4178 +/- ##
==========================================
+ Coverage 94.74% 94.75% +0.01%
==========================================
Files 186 186
Lines 7035 7035
==========================================
+ Hits 6665 6666 +1
+ Misses 370 369 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| /// use auth::credentials::Builder; | ||
| /// use auth::signer::Signer; |
There was a problem hiding this comment.
No action needed: can we use google_cloud_auth instead of auth? The customers may not know about our convenience aliases.
There was a problem hiding this comment.
I feel like would be nice to bring the Signer examples here from auth, but we can't reference google_cloud_auth as is, since we use an alias in the crate. I tried adding google_cloud_auth again without the alias, but of course cargo doesn't allow duplicate entries. Do you think a comment saying that auth is an alias to google_cloud_auth makes things better ? Not particularly happy about that
/// // auth crate is an alias for google-cloud-auth
/// use auth::credentials::Builder;
/// use auth::signer::Signer;
There was a problem hiding this comment.
Does this work:
/// # use auth as google_cloud_auth;
/// use google_cloud_auth::credentials::Builder;
??
There was a problem hiding this comment.
Sorry, missed this comment. It doesn't work:
error[E0433]: failed to resolve: use of unresolved module or unlinked crate `google_cloud_auth`
--> src/storage/src/storage/signed_url.rs:44:5
|
4 | use google_cloud_auth::signer::Signer;
| ^^^^^^^^^^^^^^^^^ use of unresolved module or unlinked crate `google_cloud_auth`
|
= help: if you wanted to use a crate named `google_cloud_auth`, use `cargo add google_cloud_auth` to add it to your `Cargo.toml`
Towards #3645