diff options
author | Aria <me@aria.rip> | 2023-11-06 00:51:21 +0000 |
---|---|---|
committer | Aria <me@aria.rip> | 2023-11-06 00:51:21 +0000 |
commit | e6afb740257b66122241fe29cde95c7b8e118565 (patch) | |
tree | 607d4cd4087bf38c367319aa5ba987d2382c7796 | |
parent | 17c830b01751d48c41e12dc8971c50b731690063 (diff) |
docs: minor docs changes
-rw-r--r-- | primrose/crates/candelabra-cli/src/candidates.rs | 8 | ||||
-rw-r--r-- | primrose/crates/candelabra-cli/src/project.rs | 4 |
2 files changed, 8 insertions, 4 deletions
diff --git a/primrose/crates/candelabra-cli/src/candidates.rs b/primrose/crates/candelabra-cli/src/candidates.rs index e3d8dc9..d134307 100644 --- a/primrose/crates/candelabra-cli/src/candidates.rs +++ b/primrose/crates/candelabra-cli/src/candidates.rs @@ -14,13 +14,17 @@ use crate::{ }; // TODO: Make this adjustable +/// The size of the model used by primrose const MODEL_SIZE: usize = 3; +/// Names a container type we want to select. pub type ConTypeName = String; -pub type StructName = String; + +/// Name of a container implementation we are considering +pub type ImplName = String; /// A list of candidate container types -pub type Candidates = HashMap<ConTypeName, Vec<StructName>>; +pub type Candidates = HashMap<ConTypeName, Vec<ImplName>>; /// Entry in the benchmark cache #[derive(Serialize, Deserialize, Debug)] diff --git a/primrose/crates/candelabra-cli/src/project.rs b/primrose/crates/candelabra-cli/src/project.rs index c0a31e0..8d04c94 100644 --- a/primrose/crates/candelabra-cli/src/project.rs +++ b/primrose/crates/candelabra-cli/src/project.rs @@ -4,7 +4,7 @@ use anyhow::{Context, Result}; use cargo_metadata::{camino::Utf8PathBuf, Package}; use glob::glob; -use crate::candidates::{CandidatesStore, ConTypeName, StructName}; +use crate::candidates::{CandidatesStore, ConTypeName, ImplName}; /// A single package or crate that we wish to process. #[derive(Debug, Clone)] @@ -46,4 +46,4 @@ impl Project { } } -pub type ProjectCandidateList = HashMap<(Utf8PathBuf, ConTypeName), Vec<StructName>>; +pub type ProjectCandidateList = HashMap<(Utf8PathBuf, ConTypeName), Vec<ImplName>>; |