Skip to content

Commit 46dee7e

Browse files
committed
Improve documentation
1 parent fb073ad commit 46dee7e

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

src/policy/builtin.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
//! Built-in policies for Sigsum.
2+
//!
3+
//! This module contains all the included built-in policies. These can be accessed
4+
//! and used directly as public statics, or looked up at runtime by name via
5+
//! [`Policy::builtin`].
6+
17
use std::ops::Deref;
28
use std::sync::LazyLock;
39

src/policy/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ impl<'a> Iterator for Logs<'a> {
6060

6161
impl Policy {
6262
/// Returns a built-in policy by name, if one exists.
63+
///
64+
/// See [`builtin`] for public static definitions of these policies.
6365
pub fn builtin(name: &str) -> Option<&'static Self> {
6466
builtin::builtin(name)
6567
}

0 commit comments

Comments
 (0)