Skip to content

Commit

Permalink
build: add cargo doc task to include private items; fix that build
Browse files Browse the repository at this point in the history
  • Loading branch information
crazyscot committed Dec 26, 2024
1 parent 0860e01 commit c8298e2
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
13 changes: 13 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}
2 changes: 1 addition & 1 deletion src/client/job.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/client/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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(<host>)
/// If neither source nor dest are present, `Ok("")`
/// If at most one of source and dest contains a remote host, `Ok(<host>)`
///
/// # Errors
/// If both source and dest contain a remote host, Err("Only one remote file argument is supported")
Expand Down

0 comments on commit c8298e2

Please sign in to comment.