@@ -7,39 +7,33 @@ use test_rpc::meta::Os;
7
7
///
8
8
/// The `test_function` macro will inject two arguments to your function:
9
9
///
10
- /// * `rpc` - a [`test_rpc::client::ServiceClient]` used to make
11
- /// remote-procedure calls inside the virtual machine running the test. This can
12
- /// be used to perform arbitrary network requests, inspect the local file
13
- /// system, rebooting ..
10
+ /// * `rpc` - a [`test_rpc::client::ServiceClient]` used to make remote-procedure calls inside the
11
+ /// virtual machine running the test. This can be used to perform arbitrary network requests,
12
+ /// inspect the local file system, rebooting ..
14
13
///
15
- /// * `mullvad_client` - a [`mullvad_management_interface::MullvadProxyClient`]
16
- /// which provides a bi-directional communication channel with the
17
- /// `mullvad-daemon` running inside of the virtual machine. All RPC-calls as
18
- /// defined in [`mullvad_management_interface::MullvadProxyClient`] are
19
- /// available on `mullvad_client`.
14
+ /// * `mullvad_client` - a [`mullvad_management_interface::MullvadProxyClient`] which provides a
15
+ /// bi-directional communication channel with the `mullvad-daemon` running inside of the virtual
16
+ /// machine. All RPC-calls as defined in [`mullvad_management_interface::MullvadProxyClient`] are
17
+ /// available on `mullvad_client`.
20
18
///
21
19
/// # Arguments
22
20
///
23
21
/// The `test_function` macro takes 4 optional arguments
24
22
///
25
- /// * `priority` - The order in which tests will be run where low numbers run
26
- /// before high numbers and tests with the same number run in undefined order.
27
- /// `priority` defaults to 0.
23
+ /// * `priority` - The order in which tests will be run where low numbers run before high numbers
24
+ /// and tests with the same number run in undefined order. `priority` defaults to 0.
28
25
///
29
- /// * `cleanup` - If the cleanup function will run after the test is finished
30
- /// and among other things reset the settings to the default value for the
31
- /// daemon.
32
- /// `cleanup` defaults to true.
26
+ /// * `cleanup` - If the cleanup function will run after the test is finished and among other things
27
+ /// reset the settings to the default value for the daemon. `cleanup` defaults to true.
33
28
///
34
- /// * `must_succeed` - If the testing suite stops running if this test fails.
35
- /// `must_succeed` defaults to false.
29
+ /// * `must_succeed` - If the testing suite stops running if this test fails. `must_succeed`
30
+ /// defaults to false.
36
31
///
37
- /// * `always_run` - If the test should always run regardless of what test
38
- /// filters are provided by the user.
39
- /// `always_run` defaults to false.
32
+ /// * `always_run` - If the test should always run regardless of what test filters are provided by
33
+ /// the user. `always_run` defaults to false.
40
34
///
41
- /// * `target_os` - The test should only run on the specified OS. This can currently be
42
- /// set to `linux`, `windows`, or `macos`.
35
+ /// * `target_os` - The test should only run on the specified OS. This can currently be set to
36
+ /// `linux`, `windows`, or `macos`.
43
37
///
44
38
/// # Examples
45
39
///
0 commit comments