This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 3d8ee5ef chore(s3): update builder region doc (#2247)
3d8ee5ef is described below
commit 3d8ee5ef63903f74a7338792bbbd7c34a5c4997e
Author: Luiz Carvalho <[email protected]>
AuthorDate: Tue May 9 15:20:08 2023 -0300
chore(s3): update builder region doc (#2247)
---
core/src/services/s3/backend.rs | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/core/src/services/s3/backend.rs b/core/src/services/s3/backend.rs
index 956a13c5..91ff14f1 100644
--- a/core/src/services/s3/backend.rs
+++ b/core/src/services/s3/backend.rs
@@ -371,10 +371,12 @@ impl S3Builder {
self
}
- /// Region represent the signing region of this endpoint.
+ /// Region represent the signing region of this endpoint. This is required
+ /// if you are using the default AWS S3 endpoint.
///
+ /// If using a custom endpoint,
/// - If region is set, we will take user's input first.
- /// - If not, we will use `us-east-1` as default.
+ /// - If not, the default `us-east-1` will be used.
pub fn region(&mut self, region: &str) -> &mut Self {
if !region.is_empty() {
self.region = Some(region.to_string())
