improve docs

This commit is contained in:
askiiart 2025-01-14 21:56:23 -06:00
parent da155441f9
commit 4ceb59d052
Signed by untrusted user who does not match committer: askiiart
GPG key ID: 6A32977DAF31746A
2 changed files with 5 additions and 1 deletions

View file

@ -1,3 +1,4 @@
//! This module translates text
use crate::core;
/// Encodes text into catspeak using any base up to [`max_base()`]

View file

@ -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