From d33eeb4a45e8c1a845efef9ede50125a43855edf Mon Sep 17 00:00:00 2001 From: roger Date: Thu, 1 Oct 2020 09:11:40 +0200 Subject: [PATCH] fixed docs refering to github in s3 backend documentation --- CHANGELOG.md | 1 + src/backends/s3.rs | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9662054..3d48f29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [unreleased] ### Added ### Changed +- Fixed docs refering to github in s3 backend ### Removed ## [0.20.0] diff --git a/src/backends/s3.rs b/src/backends/s3.rs index 504ef72..29dd3bb 100644 --- a/src/backends/s3.rs +++ b/src/backends/s3.rs @@ -137,7 +137,7 @@ impl ReleaseList { } } -/// `github::Update` builder +/// `s3::Update` builder /// /// Configure download and installation from /// `https://.s3..amazonaws.com/` @@ -182,7 +182,7 @@ impl Default for UpdateBuilder { } } -/// Configure download and installation from repo +/// Configure download and installation from bucket impl UpdateBuilder { /// Initialize a new builder pub fn new() -> Self { @@ -195,7 +195,7 @@ impl UpdateBuilder { self } - /// Set the repo name, used to build a github api url + /// Set the bucket name, used to build a s3 api url pub fn bucket_name(&mut self, name: &str) -> &mut Self { self.bucket_name = Some(name.to_owned()); self @@ -274,7 +274,7 @@ impl UpdateBuilder { /// The path provided should be: /// /// ``` - /// # use self_update::backends::github::Update; + /// # use self_update::backends::s3::Update; /// # fn run() -> Result<(), Box<::std::error::Error>> { /// Update::configure() /// .bin_path_in_archive("bin/myapp") @@ -371,7 +371,7 @@ impl UpdateBuilder { } } -/// Updates to a specified or latest release distributed via GitHub +/// Updates to a specified or latest release distributed via S3 #[derive(Debug)] pub struct Update { end_point: EndPoint,