Fix doc of desired_targets (#337)

This commit is contained in:
Jiahao XU 2022-09-05 01:11:28 +10:00 committed by GitHub
parent 79d4e9b015
commit 89869db239
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 4 deletions

View file

@ -43,8 +43,7 @@ impl DesiredTargets {
} }
} }
/// If opts_targets is `Some`, then it will be parsed in the format of /// If opts_targets is `Some`, then it will be used.
/// `$target1,$target2,...`.
/// Otherwise, call `detect_targets` using `tokio::spawn` to detect targets. /// Otherwise, call `detect_targets` using `tokio::spawn` to detect targets.
/// ///
/// Since `detect_targets` internally spawns a process and wait for it, /// Since `detect_targets` internally spawns a process and wait for it,

View file

@ -10,8 +10,8 @@
//! - [`detect_targets`] provides the API to get the target //! - [`detect_targets`] provides the API to get the target
//! at runtime, but the code is run on the current thread. //! at runtime, but the code is run on the current thread.
//! - [`get_desired_targets`] provides the API to either //! - [`get_desired_targets`] provides the API to either
//! parse `$target1,$target2,...` override provided by the users, //! use override provided by the users, or run [`detect_targets`]
//! or run [`detect_targets`] in the background using [`tokio::spawn`]. //! in the background using [`tokio::spawn`].
//! //!
//! # Example //! # Example
//! //!