c1dc050 docs: add documentation comments to cib and cibtool — radicle-ci-broker

Radicle CI broker

docs: add documentation comments to cib and cibtool

Lars Wirzenius committed 1 year ago

commit c1dc0508191d1e019ce11baa677e222246d4a421
parent ff33dcdb1e917ac366a19603012ae0a399b0df4a

2 files changed +10 -0

modified src/bin/cib.rs

@@ -1,3 +1,5 @@

 //! The CI broker.
 #![allow(clippy::result_large_err)]
 use std::{

modified src/bin/cibtool.rs

@@ -1,3 +1,11 @@

 //! A management tool for the CI broker.
 //!
 //! This tool lets the node operator query and manage the CI broker's
 //! database: the persistent event queue, the list of CI runs, etc.
 //!
 //! The tool is also used as part of the CI broker's acceptance test
 //! suite (see the `ci-broker.subplot` document).
 use std::{
     error::Error,
     fs::{read, write},