From 4ceb59d052ca8150bd26df5b91f8532ac7b840a2 Mon Sep 17 00:00:00 2001
From: askiiart <dev@askiiart.net>
Date: Tue, 14 Jan 2025 21:56:23 -0600
Subject: [PATCH] improve docs
---
src/anybase.rs | 1 +
src/base4.rs | 5 ++++-
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/src/anybase.rs b/src/anybase.rs
index 48293dd..d460fb4 100644
--- a/src/anybase.rs
+++ b/src/anybase.rs
@@ -1,3 +1,4 @@
+//! This module translates text
use crate::core;
/// Encodes text into catspeak using any base up to [`max_base()`]
diff --git a/src/base4.rs b/src/base4.rs
index 95725e3..731ba8e 100644
--- a/src/base4.rs
+++ b/src/base4.rs
@@ -1,13 +1,15 @@
+//! This module handles base 4, like the original [Cat2Text](https://github.com/Evelyn3440/Cat2Text); it can translate either english text a-z, or byte arrays (see [`bytes`])
use crate::core;
use crate::anybase;
+/// Returns the alphabet used by `cat2text::base4`
pub fn alphabet() -> Vec<String> {
let mut tmp = core::alphabet();
tmp.truncate(4);
return tmp;
}
-/// How many words long a character is when translated to catspeak
+/// How many words long an english character is when translated to catspeak
pub fn char_length() -> u32 {
return 3;
}
@@ -36,6 +38,7 @@ pub fn decode(text: String) -> String {
}
pub mod bytes {
+ //! This handles encoding and decoding bytes to/from catspeak
use crate::anybase;
use super::char_length;
/// Encodes from bytes into catspeak