Add doc comments

Author: cruessler

gitoxide-core/src/repository/commit.rs

@@ -47,6 +47,8 @@ pub fn verify(repo: gix::Repository, rev_spec: Option<&str>) -> Result<()> {
     Ok(())
 }
 
+/// Note that this is a quick first prototype that lacks some of the features provided by `git
+/// verify-commit`.
 pub fn sign(repo: gix::Repository, rev_spec: Option<&str>, mut out: impl std::io::Write) -> Result<()> {
     let rev_spec = rev_spec.unwrap_or("HEAD");
     let object = repo

src/plumbing/options/mod.rs

@@ -912,7 +912,8 @@ pub mod commit {
             /// A specification of the revision to verify, or the current `HEAD` if unset.
             rev_spec: Option<String>,
         },
-        /// TODO: add description.
+        /// Sign a commit and print the signed commit's id to stdout. This command does not change
+        /// symbolic refs.
         Sign {
             /// A specification of the revision to sign, or the current `HEAD` if unset.
             rev_spec: Option<String>,