diff --git a/.vscode/tasks.json b/.vscode/tasks.json index af22b87..8364bf0 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -13,6 +13,19 @@ "isDefault": false }, "label": "rust: cargo doc" + }, + { + "type": "cargo", + "command": "doc", + "args": ["--no-deps", "--locked", "--document-private-items"], + "problemMatcher": [ + "$rustc" + ], + "group": { + "kind": "build", + "isDefault": false + }, + "label": "rust: cargo doc --document-private-items" } ] } diff --git a/src/client/job.rs b/src/client/job.rs index 4cc52d8..f2501f3 100644 --- a/src/client/job.rs +++ b/src/client/job.rs @@ -70,7 +70,7 @@ impl CopyJobSpec { } } - /// The [user@]hostname portion of whichever of the arguments contained a hostname. + /// The `[user@]hostname` portion of whichever of the arguments contained a hostname. fn remote_user_host(&self) -> &str { self.source .host diff --git a/src/client/options.rs b/src/client/options.rs index c38b807..e22dd5b 100644 --- a/src/client/options.rs +++ b/src/client/options.rs @@ -101,8 +101,8 @@ impl Parameters { /// A best-effort attempt to extract a single remote host string from the parameters. /// /// # Output - /// If neither source nor dest are present, Ok("") - /// If at most one of source and dest contains a remote host, Ok() + /// If neither source nor dest are present, `Ok("")` + /// If at most one of source and dest contains a remote host, `Ok()` /// /// # Errors /// If both source and dest contain a remote host, Err("Only one remote file argument is supported")