documentation

dioptra-io · Aug 24, 2022 · d725707 · d725707
1 parent c66597c
commit d725707
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/src/atlas/mod.rs b/src/atlas/mod.rs
@@ -1,4 +1,8 @@
 //! RIPE Atlas newline-delimited JSON format.
+//!
+//! This format is obtained by passing the `format=txt` parameter to the RIPE Atlas API.
+//! For example:
+//! [https://atlas.ripe.net/api/v2/measurements/23119200/results/?start=1625097600&stop=1625788799&probe_ids=6479&format=txt](https://atlas.ripe.net/api/v2/measurements/23119200/results/?start=1625097600&stop=1625788799&probe_ids=6479&format=txt)
 mod from;
 mod models;
 mod reader;

diff --git a/src/warts_trace/mod.rs b/src/warts_trace/mod.rs
@@ -1,4 +1,9 @@
 //! Scamper's warts format with trace objects.
+//!
+//! This format is typically used for [CAIDA's Ark](https://www.caida.org/projects/ark/) data.
+//!
+//! The [warts](https://github.com/dioptra-io/warts) library is used to read and write the
+//! [`warts(5)`](https://www.caida.org/catalog/software/scamper/man/warts.5.pdf) files.
 mod from;
 mod reader;
 mod to;

diff --git a/src/warts_trace/to.rs b/src/warts_trace/to.rs
@@ -5,6 +5,7 @@ use std::net::Ipv6Addr;
 use std::ops::Add;
 use warts::{Address, Timeval, TraceProbe, TraceType, Traceroute};
 
+/// Build an array of [TracerouteReply] from a [Traceroute].
 pub fn warts_trace_to_internal(
     traceroute: &Traceroute,
     cycle_id: u32,