Skip to content

Commit 461991f

Browse files
committed
Documents asciiquarium assets module
Adds documentation to the asciiquarium assets module, explaining its purpose and usage. Also fixes a formatting inconsistency in `src/lib.rs`.
1 parent 1d804ae commit 461991f

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Agent Log:
88
99
Next steps for agents:
1010
- Ensure `src/widgets/mod.rs` declares:
11-
pub mod asciiquarium;
12-
pub mod asciiquarium_assets;
11+
pub mod asciiquarium;
12+
pub mod asciiquarium_assets;
1313
*/
1414

1515
#![forbid(unsafe_code)]

src/widgets/asciiquarium_assets.rs

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1-
use super::asciiquarium::FishArt;
1+
/*!
2+
Asciiquarium assets: a small curated set of ASCII fish plus a helper to auto-measure width and height for any multi-line ASCII art.
3+
4+
Notes:
5+
- Width is the maximum visible character count across all lines (Unicode scalar count).
6+
- Height is the total number of lines returned by `.lines()`.
7+
- Leading/trailing blank lines in raw strings will count toward height.
8+
- Rendering code will clip as needed; assets need not avoid whitespace.
9+
10+
These assets are intentionally simple; expand as desired with additional creatures.
211
3-
/// Asciiquarium assets: a small curated set of ASCII fish plus a helper
4-
/// to auto-measure width and height for any multi-line ASCII art.
5-
///
6-
/// Notes:
7-
/// - Width is the maximum visible character count across all lines (Unicode scalar count).
8-
/// - Height is the total number of lines returned by `.lines()`.
9-
/// - Leading/trailing blank lines in raw strings will count toward height.
10-
/// - Rendering code will clip as needed; assets need not avoid whitespace.
11-
///
12-
/// These assets are intentionally simple; expand as desired with additional creatures.
12+
Example:
13+
```text
14+
<º)))><
15+
```
16+
*/
17+
18+
use super::asciiquarium::FishArt;
1319

1420
const FISH_01: &str = r#"<º)))><"#; // Facing right
1521
const FISH_02: &str = r#"><(((º>"#; // Facing left

0 commit comments

Comments
 (0)