From 7817909a6922a0ee6db9848be5cca9f82c71ecfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Mon, 15 Nov 2021 13:17:35 +0100 Subject: [PATCH] pkstrings: Add some module level doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- pkstrings/src/pkstring.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/pkstrings/src/pkstring.rs b/pkstrings/src/pkstring.rs index ec9432f..12d3792 100644 --- a/pkstrings/src/pkstring.rs +++ b/pkstrings/src/pkstring.rs @@ -13,6 +13,13 @@ // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . +//! Handles string encoding and decoding for the English version of Pokémon Gen 1. +//! +//! Documentation can be found at: +//! https://bulbapedia.bulbagarden.net/wiki/Character_encoding_(Generation_I) +//! +//! Control characters are considered valid but not handled yet. + use std::convert::TryFrom; use std::fmt; use std::ops::Deref;