extend doc comment

This commit is contained in:
Niko Matsakis 2018-10-18 21:20:46 -04:00
parent 85f2357ebe
commit 2410a2242c

View file

@ -140,10 +140,10 @@ where
/// expand into a trait and a set of structs, one per query. /// expand into a trait and a set of structs, one per query.
/// ///
/// For each query, you give the name of the accessor method to invoke /// For each query, you give the name of the accessor method to invoke
/// the query (e.g., `my_query`, below), as well as its input/output /// the query (e.g., `my_query`, below), as well as its parameter
/// types. You also give the name for a query type (e.g., `MyQuery`, /// types and the output type. You also give the name for a query type
/// below) that represents the query, and optionally other details, /// (e.g., `MyQuery`, below) that represents the query, and optionally
/// such as its storage. /// other details, such as its storage.
/// ///
/// ### Examples /// ### Examples
/// ///
@ -158,6 +158,12 @@ where
/// storage memoized; // optional, this is the default /// storage memoized; // optional, this is the default
/// use fn path::to::fn; // optional, default is `my_query` /// use fn path::to::fn; // optional, default is `my_query`
/// } /// }
///
/// /// Queries can have any number of inputs; the key type will be
/// /// a tuple of the input types, so in this case `(u32, f32)`.
/// fn other_query(input1: u32, input2: f32) -> u64 {
/// type OtherQuery;
/// }
/// } /// }
/// } /// }
/// ``` /// ```