From d11467a31808c85a0e4b8a67ac132fe87efc7286 Mon Sep 17 00:00:00 2001 From: steven-omaha <35634100+steven-omaha@users.noreply.github.com> Date: Tue, 6 Jun 2023 16:14:28 +0200 Subject: [PATCH] docs(core): docstrings --- crates/pacdef_core/src/core.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/crates/pacdef_core/src/core.rs b/crates/pacdef_core/src/core.rs index e40dc5a..be66264 100644 --- a/crates/pacdef_core/src/core.rs +++ b/crates/pacdef_core/src/core.rs @@ -233,6 +233,10 @@ impl Pacdef { Ok(result) } + /// Print the alphabetically sorted names of all groups to stdout. + /// + /// This methods cannot return an error. It returns a `Result` to be consistent + /// with other methods. #[allow(clippy::unnecessary_wraps)] fn show_groups(self) -> Result<()> { if self.groups.is_empty() {