Feat: WIP terse code documentation

crates/project/src/share.rs

@@ -11,6 +11,7 @@ use crate::{Bank, Pattern};
 const PATTERN_PREFIX: &str = "cgr:";
 const BANK_PREFIX: &str = "cgrb:";
 
+/// Error during pattern or bank import/export.
 #[derive(Debug)]
 pub enum ShareError {
     InvalidPrefix,
@@ -67,18 +68,22 @@ fn decode<T: serde::de::DeserializeOwned>(text: &str, prefix: &str) -> Result<T,
     rmp_serde::from_slice(&packed).map_err(ShareError::Deserialize)
 }
 
+/// Encode a pattern as a shareable `cgr:` string.
 pub fn export(pattern: &Pattern) -> Result<String, ShareError> {
     encode(pattern, PATTERN_PREFIX)
 }
 
+/// Decode a `cgr:` string back into a pattern.
 pub fn import(text: &str) -> Result<Pattern, ShareError> {
     decode(text, PATTERN_PREFIX)
 }
 
+/// Encode a bank as a shareable `cgrb:` string.
 pub fn export_bank(bank: &Bank) -> Result<String, ShareError> {
     encode(bank, BANK_PREFIX)
 }
 
+/// Decode a `cgrb:` string back into a bank.
 pub fn import_bank(text: &str) -> Result<Bank, ShareError> {
     decode(text, BANK_PREFIX)
 }