More docs

Author: rylev

database/src/lib.rs

@@ -378,9 +378,12 @@ pub enum Label {
     Query(QueryLabel),
 }
 
+/// An identifier for a built version of the compiler
 #[derive(Deserialize, Serialize, Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub enum ArtifactId {
+    /// A built version of the compiler at an exact commit
     Commit(Commit),
+    /// A symbolic tag for a built compiler like "1.51.0"
     Artifact(String),
 }
 

site/src/selector.rs

@@ -33,10 +33,10 @@ use std::fmt;
 use std::ops::RangeInclusive;
 use std::sync::Arc;
 
-/// Gets an artifact id for the given bound
+/// Finds the most appropriate `ArtifactId` for a given bound.
 ///
-/// Searches in the indexed commits either from the right or left
-/// If not found in the indexed commits, searches through the artifacts cache
+/// Searches the commits in the index either from the left or the right.
+/// If not found in those commits, searches through the artifacts in the index.
 pub fn data_for(data: &Index, is_left: bool, bound: Bound) -> Option<ArtifactId> {
     let commits = data.commits();
     let commit = if is_left {