Add top level docs

Author: johnlees

src/distances.rs

@@ -1,3 +1,4 @@
+//! Functions and traits for calculating and storing distances
 use std::cmp::Ordering;
 use std::fmt;
 

src/hashing/mod.rs

@@ -1,3 +1,4 @@
+//! [nthash](https://github.com/bcgsc/ntHash[) and [aahash](https://github.com/bcgsc/ntHash) iterators
 use clap::ValueEnum;
 use serde::{Deserialize, Serialize};
 

src/io.rs

@@ -1,3 +1,4 @@
+//! Functions to read input fasta/fastq files
 use std::fs::File;
 use std::io::{stdout, BufRead, BufReader, BufWriter, Write};
 use std::path::Path;

src/jaccard.rs

@@ -1,3 +1,4 @@
+//! Implementation of Jaccard, core and accessory distance calculations
 use crate::multisketch::MultiSketch;
 use crate::sketch::BBITS;
 

src/lib.rs

@@ -1,5 +1,10 @@
-//! DOCS
+//! Fast distance calculations between biological sequences (DNA, AA or structures
+//! via the 3di alphabet). Distances are based on bindash approximations of the Jaccard
+//! distance, with the PopPUNK method to calculate core and accessory distances. nthash/aahash
+//! are used for hash functions to create the sketches
 //!
+//! This package is a work in progress, but is mature enough for research use. See README.md
+//! for current CLI usage.
 
 // #![warn(missing_docs)]
 

src/multisketch.rs

@@ -1,3 +1,4 @@
+//! The class to support .skm/.skd reading and writing, containing multiple [`Sketch`] objects
 use anyhow::bail;
 use anyhow::Error;
 use anyhow::{Result, anyhow};

src/sketch.rs

@@ -1,3 +1,4 @@
+//! Methods to create single sample's sketch
 use std::cmp::Ordering;
 use std::fmt;
 use std::sync::mpsc;

src/sketch_datafile.rs

@@ -1,3 +1,4 @@
+//! I/O support and memory mapping used by for lower level read/write to .skd
 use memmap2::Mmap;
 use std::error::Error;
 use std::fs::File;

src/structures.rs

@@ -1,3 +1,4 @@
+//! Support for .pdb files and the 3di alphabet
 use anyhow::Error;
 use crate::io::InputFastx;