pkstrings: Add some module level doc

Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
Maxime “pep” Buquet 2021-11-15 13:17:35 +01:00
parent 0a3a455b31
commit 7817909a69
Signed by: pep
GPG key ID: DEDA74AEECA9D0F2

View file

@ -13,6 +13,13 @@
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//! 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;