diff --git a/lychee-bin/src/main.rs b/lychee-bin/src/main.rs index 3535fea9d5..2715d178a8 100644 --- a/lychee-bin/src/main.rs +++ b/lychee-bin/src/main.rs @@ -383,7 +383,7 @@ async fn run(opts: &LycheeOptions) -> Result { if github_issues && opts.config.github_token.is_none() { let mut handle = io::stderr(); - color!(handle, YELLOW, "\u{1f4a1} There were issues with Github URLs. You could try setting a Github token and running lychee again.",)?; + color!(handle, YELLOW, "\u{1f4a1} There were issues with GitHub URLs. You could try setting a GitHub token and running lychee again.",)?; } if opts.config.cache { diff --git a/lychee-bin/tests/cli.rs b/lychee-bin/tests/cli.rs index aed26341ea..931783a668 100644 --- a/lychee-bin/tests/cli.rs +++ b/lychee-bin/tests/cli.rs @@ -416,7 +416,7 @@ mod cli { "✗ [404] https://github.com/mre/idiomatic-rust-doesnt-exist-man | Failed: Network error: Not Found" )) .stderr(contains( - "There were issues with Github URLs. You could try setting a Github token and running lychee again.", + "There were issues with GitHub URLs. You could try setting a GitHub token and running lychee again.", )); } diff --git a/lychee-lib/src/client.rs b/lychee-lib/src/client.rs index e7d687761a..77b132f700 100644 --- a/lychee-lib/src/client.rs +++ b/lychee-lib/src/client.rs @@ -300,7 +300,7 @@ impl ClientBuilder { /// - The reqwest client cannot be instantiated. This occurs if a TLS /// backend cannot be initialized or the resolver fails to load the system /// configuration. See [here]. - /// - The Github client cannot be created. Since the implementation also + /// - The GitHub client cannot be created. Since the implementation also /// uses reqwest under the hood, this errors in the same circumstances as /// the last one. /// @@ -604,7 +604,7 @@ impl Client { if let Ok(github_uri) = GithubUri::try_from(uri) { let status = self.check_github(github_uri).await; - // Only return Github status in case of success + // Only return GitHub status in case of success // Otherwise return the original error, which has more information if status.is_success() { return status; diff --git a/lychee-lib/src/collector.rs b/lychee-lib/src/collector.rs index 821b3593d7..ed048abc9e 100644 --- a/lychee-lib/src/collector.rs +++ b/lychee-lib/src/collector.rs @@ -351,7 +351,7 @@ mod tests { async fn test_relative_url_with_base_extracted_from_input() { let contents = r#"
- Github + GitHub About
"#; diff --git a/lychee-lib/src/extract/mod.rs b/lychee-lib/src/extract/mod.rs index 39d15cf8db..e0c0ee44bb 100644 --- a/lychee-lib/src/extract/mod.rs +++ b/lychee-lib/src/extract/mod.rs @@ -190,7 +190,7 @@ mod tests { let contents = r#"
- Github + GitHub About
"#; diff --git a/lychee-lib/src/retry.rs b/lychee-lib/src/retry.rs index 0eed204f20..cff2eaa487 100644 --- a/lychee-lib/src/retry.rs +++ b/lychee-lib/src/retry.rs @@ -95,7 +95,7 @@ impl RetryExt for ErrorKind { // If the error is a `reqwest::Error`, delegate to that if let Some(r) = self.reqwest_error() { r.should_retry() - // Github errors sometimes wrap `reqwest` errors. + // GitHub errors sometimes wrap `reqwest` errors. // In that case, delegate to the underlying error. } else if let Some(octocrab::Error::Http { source, diff --git a/lychee-lib/src/types/error.rs b/lychee-lib/src/types/error.rs index 0ebd031b05..f2104741ea 100644 --- a/lychee-lib/src/types/error.rs +++ b/lychee-lib/src/types/error.rs @@ -24,7 +24,7 @@ pub enum ErrorKind { #[error("Error creating request client: {0}")] BuildRequestClient(#[source] reqwest::Error), - /// Network error while using Github API + /// Network error while using GitHub API #[error("Network error (GitHub client)")] GithubRequest(#[from] octocrab::Error), @@ -44,12 +44,12 @@ pub enum ErrorKind { #[error("Attempted to interpret an invalid sequence of bytes as a string")] Utf8(#[from] std::str::Utf8Error), - /// The Github client required for making requests cannot be created - #[error("Error creating Github client")] + /// The GitHub client required for making requests cannot be created + #[error("Error creating GitHub client")] BuildGithubClient(#[source] octocrab::Error), - /// Invalid Github URL - #[error("Github URL is invalid: {0}")] + /// Invalid GitHub URL + #[error("GitHub URL is invalid: {0}")] InvalidGithubUrl(String), /// The input is empty and not accepted as a valid URL @@ -102,7 +102,7 @@ pub enum ErrorKind { #[error("UNIX glob pattern is invalid")] InvalidGlobPattern(#[from] glob::PatternError), - /// The Github API could not be called because of a missing Github token. + /// The GitHub API could not be called because of a missing GitHub token. #[error("GitHub token not specified. To check GitHub links reliably, use `--github-token` flag / `GITHUB_TOKEN` env var.")] MissingGitHubToken, diff --git a/lychee-lib/src/types/uri/github.rs b/lychee-lib/src/types/uri/github.rs index 68ba3d97b3..514f2e0e76 100644 --- a/lychee-lib/src/types/uri/github.rs +++ b/lychee-lib/src/types/uri/github.rs @@ -23,7 +23,7 @@ static GITHUB_API_EXCLUDED_ENDPOINTS: Lazy> = Lazy::new(|| ]) }); -/// Uri path segments extracted from a Github URL +/// Uri path segments extracted from a GitHub URL #[derive(PartialEq, Eq, PartialOrd, Ord, Debug)] pub struct GithubUri { /// Organization name @@ -35,7 +35,7 @@ pub struct GithubUri { } impl GithubUri { - /// Create a new Github URI without an endpoint + /// Create a new GitHub URI without an endpoint #[cfg(test)] fn new>(owner: T, repo: T) -> Self { GithubUri { @@ -83,7 +83,7 @@ impl GithubUri { if parts.len() < 2 { // Not a valid org/repo pair. - // Note: We don't check for exactly 2 here, because the Github + // Note: We don't check for exactly 2 here, because the GitHub // API doesn't handle checking individual files inside repos or // paths like , so we are more // permissive and only check for repo existence. This is the