Update documentation

iscc · Nov 23, 2024 · a75da8b · a75da8b
1 parent dc9aead
commit a75da8b
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,13 @@
 # Changelog
 
 ## [1.1.0] - Unreleased
-- Set CDC index to size if size is smaller than minimum chunk size
-- Added Python 3.13 support
-- Added .env to .gitignore
+- Added support for Python 3.13
 - Added multiformats support for codec convenience functions
-- Added `iscc_validate_mf` for validation of canonical and multiformat codes
-- Fixed data-url api change
+- Added `iscc_validate_mf` for validation of multiformat codes
+- Changed CDC index to size if size is smaller than minimum chunk size
 - Updated dependency lock file
-- Removed EOL Python 3.8/3.9 support
+- Fixed `data-url` api change
+- Removed Python 3.8 support (EOL)
 
 ## [1.0.9] - 2024-03-17
 - Updated dependencies

diff --git a/README.md b/README.md
@@ -186,7 +186,7 @@ Documentation is published at <https://core.iscc.codes>
 
 **Requirements**
 
-- [Python 3.7.2](https://www.python.org/) or higher for code generation and static site building.
+- [Python 3.9](https://www.python.org/) or higher for code generation and static site building.
 - [Poetry](https://python-poetry.org/) for installation and dependency management.
 
 **Development Setup**

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,14 +1,13 @@
 # Changelog
 
 ## [1.1.0] - Unreleased
-- Set CDC index to size if size is smaller than minimum chunk size
-- Added Python 3.13 support
-- Added .env to .gitignore
+- Added support for Python 3.13
 - Added multiformats support for codec convenience functions
-- Added `iscc_validate_mf` for validation of canonical and multiformat codes
-- Fixed data-url api change
+- Added `iscc_validate_mf` for validation of multiformat codes
+- Changed CDC index to size if size is smaller than minimum chunk size
 - Updated dependency lock file
-- Removed EOL Python 3.8/3.9 support
+- Fixed `data-url` api change
+- Removed Python 3.8 support (EOL)
 
 ## [1.0.9] - 2024-03-17
 - Updated dependencies

diff --git a/docs/codec/index.md b/docs/codec/index.md
@@ -39,6 +39,7 @@ This module implements encoding, decoding and transcoding functions of ISCC
             - decode_base64
             - encode_base32hex
             - decode_base32hex
+            - normalize_multiformat
 
 
 ## Helper Functions
@@ -52,4 +53,5 @@ This module implements encoding, decoding and transcoding functions of ISCC
             - iscc_explain
             - iscc_type_id
             - iscc_validate
+            - iscc_validate_mf
             - iscc_clean
diff --git a/docs/index.md b/docs/index.md
@@ -187,7 +187,7 @@ Documentation is published at <https://core.iscc.codes>
 
 **Requirements**
 
-- [Python 3.7.2](https://www.python.org/) or higher for code generation and static site building.
+- [Python 3.9](https://www.python.org/) or higher for code generation and static site building.
 - [Poetry](https://python-poetry.org/) for installation and dependency management.
 
 **Development Setup**

diff --git a/iscc_core/codec.py b/iscc_core/codec.py
@@ -327,7 +327,7 @@ def decode_base32hex(code):
 
 def normalize_multiformat(iscc_code):
     """
-    Transcode a multiformat encoded ISCC to standard base32 encoding.
+    Normalize a multiformat encoded ISCC to standard base32 encoding.
     Returns the input unchanged (but cleaned) if it's not multiformat encoded.
     """
     decoders = {