Skip to content

Commit bee2529

Browse files
authored
docs: fix comments for alternative registry fns (#16235)
### What does this PR try to resolve? The comments added in 340656e2, but after we change its implementations a couple of times, it no longer accepts a bool. So, it would be better to fix the comments for them. ### How to test and review this PR? It is just a comment change, so no need to test.
2 parents 6ab22e3 + 3e920f2 commit bee2529

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

crates/cargo-test-support/src/registry.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,14 +282,14 @@ impl RegistryBuilder {
282282
self
283283
}
284284

285-
/// Sets whether or not to initialize as an alternative registry.
285+
/// Initializes as an alternative registry with the given name.
286286
#[must_use]
287287
pub fn alternative_named(mut self, alt: &str) -> Self {
288288
self.alternative = Some(alt.to_string());
289289
self
290290
}
291291

292-
/// Sets whether or not to initialize as an alternative registry.
292+
/// Initializes as an alternative registry named "alternative".
293293
#[must_use]
294294
pub fn alternative(self) -> Self {
295295
self.alternative_named("alternative")

0 commit comments

Comments
 (0)