Add documentation for the new krate and version submodules

Author: jtgeibel

src/krate/downloads.rs

@@ -1,3 +1,8 @@
+//! Endpoint for exposing crate download counts
+//!
+//! The enpoints for download a crate and exposing version specific
+//! download counts are located in `krate::downloads`.
+
 use std::cmp;
 
 use conduit::{Request, Response};

src/krate/metadata.rs

@@ -1,3 +1,9 @@
+//! Endpoints that expose metadata about a crate
+//!
+//! These endpoints provide data that could be obtained direclty from the
+//! index or cached metadata which was extracted (client side) from the
+//! `Cargo.toml` file.
+
 use conduit::{Request, Response};
 use conduit_router::RequestParams;
 use diesel::prelude::*;

src/krate/publish.rs

@@ -1,3 +1,5 @@
+//! Functionality related to publishing a new crate or version of a crate.
+
 use std::collections::HashMap;
 use std::sync::Arc;
 

src/krate/search.rs

@@ -1,3 +1,5 @@
+//! Endpoint for searching and discovery functionality
+
 use conduit::{Request, Response};
 use diesel::prelude::*;
 use diesel_full_text_search::*;

src/version/downloads.rs

@@ -1,3 +1,7 @@
+//! Functionality for downloading crates and maintaining download counts
+//!
+//! Crate level functionality is located in `krate::downloads`.
+
 use chrono::{Duration, NaiveDate, Utc};
 use conduit::{Request, Response};
 use conduit_router::RequestParams;

src/version/yank.rs

@@ -1,3 +1,5 @@
+//! Endpoints for yanking and unyanking specific versions of crates
+
 use conduit::{Request, Response};
 use diesel;
 use diesel::prelude::*;