Skip to content

Commit a75da8b

Browse files
committed
Update documentation
1 parent dc9aead commit a75da8b

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

CHANGELOG.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Changelog
22

33
## [1.1.0] - Unreleased
4-
- Set CDC index to size if size is smaller than minimum chunk size
5-
- Added Python 3.13 support
6-
- Added .env to .gitignore
4+
- Added support for Python 3.13
75
- Added multiformats support for codec convenience functions
8-
- Added `iscc_validate_mf` for validation of canonical and multiformat codes
9-
- Fixed data-url api change
6+
- Added `iscc_validate_mf` for validation of multiformat codes
7+
- Changed CDC index to size if size is smaller than minimum chunk size
108
- Updated dependency lock file
11-
- Removed EOL Python 3.8/3.9 support
9+
- Fixed `data-url` api change
10+
- Removed Python 3.8 support (EOL)
1211

1312
## [1.0.9] - 2024-03-17
1413
- Updated dependencies

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Documentation is published at <https://core.iscc.codes>
186186

187187
**Requirements**
188188

189-
- [Python 3.7.2](https://www.python.org/) or higher for code generation and static site building.
189+
- [Python 3.9](https://www.python.org/) or higher for code generation and static site building.
190190
- [Poetry](https://python-poetry.org/) for installation and dependency management.
191191

192192
**Development Setup**

docs/changelog.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Changelog
22

33
## [1.1.0] - Unreleased
4-
- Set CDC index to size if size is smaller than minimum chunk size
5-
- Added Python 3.13 support
6-
- Added .env to .gitignore
4+
- Added support for Python 3.13
75
- Added multiformats support for codec convenience functions
8-
- Added `iscc_validate_mf` for validation of canonical and multiformat codes
9-
- Fixed data-url api change
6+
- Added `iscc_validate_mf` for validation of multiformat codes
7+
- Changed CDC index to size if size is smaller than minimum chunk size
108
- Updated dependency lock file
11-
- Removed EOL Python 3.8/3.9 support
9+
- Fixed `data-url` api change
10+
- Removed Python 3.8 support (EOL)
1211

1312
## [1.0.9] - 2024-03-17
1413
- Updated dependencies

docs/codec/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ This module implements encoding, decoding and transcoding functions of ISCC
3939
- decode_base64
4040
- encode_base32hex
4141
- decode_base32hex
42+
- normalize_multiformat
4243

4344

4445
## Helper Functions
@@ -52,4 +53,5 @@ This module implements encoding, decoding and transcoding functions of ISCC
5253
- iscc_explain
5354
- iscc_type_id
5455
- iscc_validate
56+
- iscc_validate_mf
5557
- iscc_clean

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Documentation is published at <https://core.iscc.codes>
187187

188188
**Requirements**
189189

190-
- [Python 3.7.2](https://www.python.org/) or higher for code generation and static site building.
190+
- [Python 3.9](https://www.python.org/) or higher for code generation and static site building.
191191
- [Poetry](https://python-poetry.org/) for installation and dependency management.
192192

193193
**Development Setup**

iscc_core/codec.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ def decode_base32hex(code):
327327

328328
def normalize_multiformat(iscc_code):
329329
"""
330-
Transcode a multiformat encoded ISCC to standard base32 encoding.
330+
Normalize a multiformat encoded ISCC to standard base32 encoding.
331331
Returns the input unchanged (but cleaned) if it's not multiformat encoded.
332332
"""
333333
decoders = {

0 commit comments

Comments
 (0)