Skip to content

Commit

Permalink
cleanup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
divagant-martian committed Oct 29, 2024
1 parent 5e1e3e1 commit e9959e5
Showing 1 changed file with 2 additions and 14 deletions.
16 changes: 2 additions & 14 deletions net-tools/netwatch/src/interfaces.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,7 @@ impl Interface {

/// Creates a fake interface for usage in tests.
///
/// Sometimes tests want to be deterministic, e.g. [`ProbePlan`] tests rely on the
/// interface state. This allows tests to be independent of the host interfaces.
///
/// It is rather possible that we'll want more variations of this in the future, feel
/// free to add parameters or different alternative constructors.
///
/// [`ProbePlan`]: crate::netcheck::reportgen::probes::ProbePlan
/// This allows tests to be independent of the host interfaces.
pub(crate) fn fake() -> Self {
use std::net::Ipv4Addr;

Expand Down Expand Up @@ -254,13 +248,7 @@ impl State {

/// Creates a fake interface state for usage in tests.
///
/// Sometimes tests want to be deterministic, e.g. [`ProbePlan`] tests rely on the
/// interface state. This allows tests to be independent of the host interfaces.
///
/// It is rather possible that we'll want more variations of this in the future, feel
/// free to add parameters or different alternative constructors.
///
/// [`ProbePlan`]: crate::netcheck::reportgen::probes::ProbePlan
/// This allows tests to be independent of the host interfaces.
pub fn fake() -> Self {
let fake = Interface::fake();
let ifname = fake.iface.name.clone();
Expand Down

0 comments on commit e9959e5

Please sign in to comment.