Skip to content

Commit 2d4fa10

Browse files
committed
fix clippy
1 parent c376e06 commit 2d4fa10

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

rust/catalyst-signed-doc-spec/src/doc_types.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//!
1+
//! 'type' array field definition
22
33
use std::ops::Deref;
44

rust/catalyst-signed-doc-spec/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ pub struct DocumentName(String);
2929

3030
impl DocumentName {
3131
/// returns document name
32+
#[must_use]
3233
pub fn name(&self) -> &str {
3334
&self.0
3435
}
@@ -58,6 +59,11 @@ pub struct DocSpec {
5859

5960
impl CatalystSignedDocSpec {
6061
/// Loading a Catalyst Signed Documents spec from the `signed_doc.json`
62+
///
63+
/// # Errors
64+
/// - `signed_doc.json` filed loading and JSON parsing errors
65+
/// - `catalyst-signed-doc-spec` crate version doesn't align with the latest version
66+
/// of the `signed_doc.json`
6167
pub fn load_signed_doc_spec() -> anyhow::Result<CatalystSignedDocSpec> {
6268
let signed_doc_str = include_str!("../../../specs/signed_doc.json");
6369
let signed_doc_spec: CatalystSignedDocSpec = serde_json::from_str(signed_doc_str)

0 commit comments

Comments
 (0)