From f18135ee7fc663aeb234236c08f4999381bb27f4 Mon Sep 17 00:00:00 2001 From: Karol Stasiak Date: Wed, 4 Sep 2019 01:22:40 +0200 Subject: [PATCH] Update documentation --- docs/stdlib/string.md | 4 ++++ mkdocs.yml | 2 ++ 2 files changed, 6 insertions(+) diff --git a/docs/stdlib/string.md b/docs/stdlib/string.md index 5f444046..e4ca6f4d 100644 --- a/docs/stdlib/string.md +++ b/docs/stdlib/string.md @@ -4,6 +4,10 @@ The `string` module automatically imports the `err` module. +All the functions are designed to work for the strings in the default encoding. +If passed a string in an encoding that has a different null terminator, +then the results are undefined and the program will most likely crash or freeze. + #### `byte strzlen(pointer str)` Calculates the length of a null-terminated string. diff --git a/mkdocs.yml b/mkdocs.yml index 5c4c563b..3ee1536d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,6 +23,7 @@ nav: - Syntax: lang/syntax.md - Types: lang/types.md - Literals: lang/literals.md + - Predefined constants: lang/predefined_constants.md - Text encodings: lang/text.md - Operators: lang/operators.md - Functions: lang/functions.md @@ -35,6 +36,7 @@ nav: - stdio module: stdlib/stdio.md - keyboard, err, random: stdlib/other.md - joy, mouse, x_coord: stdlib/input.md + - encconv module: stdlib/encconv.md - Platform-dependent modules: stdlib/frequent.md - cbm_file module: stdlib/cbm_file.md - C64-only modules: stdlib/c64.md