workspacer_cli/
document.rs

1// ---------------- [ File: workspacer-cli/src/document.rs ]
2crate::ix!();
3
4/// Document the workspace or crate (like cargo doc)
5#[derive(Debug, StructOpt)]
6pub enum DocumentSubcommand {
7    Crate {
8        #[structopt(long = "crate")]
9        crate_name: PathBuf,
10    },
11    Workspace {
12        #[structopt(long = "path")]
13        path: PathBuf,
14    },
15}
16
17impl DocumentSubcommand {
18    pub async fn run(&self) -> Result<(),WorkspaceError> {
19        todo!("We have not implemented this functionality yet. 
20            The goal of this command is to use a language model to scrub the whole crate.
21            The language model will ensure that everything is properly documented. 
22            It is possible that we will implement this once it has become critical path. 
23            In the meantime -- to help implement this functionality, please visit https://github.com/klebs6/klebs-general to submit a PR");
24    }
25}
workspacer_cli/document.rs

workspacer_cli/
document.rs
