From 0c4500897f792451333d77f75aef05efd4f1e8de Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Mon, 9 Oct 2017 13:50:03 -0700 Subject: [PATCH] Clarify FunctionName's role in its comment. --- lib/cretonne/src/ir/funcname.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/cretonne/src/ir/funcname.rs b/lib/cretonne/src/ir/funcname.rs index 142a846c22..0cffae6d7c 100644 --- a/lib/cretonne/src/ir/funcname.rs +++ b/lib/cretonne/src/ir/funcname.rs @@ -8,8 +8,12 @@ use std::ascii::AsciiExt; /// The name of a function can be any sequence of bytes. /// -/// Function names are mostly a testing and debugging tool. -/// In particular, `.cton` files use function names to identify functions. +/// Function names are primarily used as keys by code using Cretonne to map +/// from a cretonne::ir::Function to additional associated data. +/// +/// Function names can also serve as a primitive testing and debugging tool. +/// In particular, many `.cton` test files use function names to identify +/// functions. #[derive(Debug, Clone, PartialEq, Eq, Default)] pub struct FunctionName(NameRepr);