debt: Documentation corrections and errata addressed for improved cla…

…rity and accuracy. (#33)
sixafter · Nov 12, 2024 · 186e233 · 186e233
1 parent ca85669
commit 186e233
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/CHANGELOG/CHANGELOG-1.x.md b/CHANGELOG/CHANGELOG-1.x.md
@@ -15,6 +15,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
+---
+## [1.17.2] - 2024-NOV-12
+
+### Added
+### Changed
+- **DEFECT:** Corrected a few typos in the documentation.
+- **DEBT:** Refactored documentation to improve readability and clarity.
+### Deprecated
+### Removed
+### Fixed
+### Security
+
 ---
 ## [1.17.1] - 2024-NOV-12
 
@@ -386,7 +398,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/scriptures-social/platform/compare/v1.17.1..HEAD
+[Unreleased]: https://github.com/scriptures-social/platform/compare/v1.17.2..HEAD
+[1.17.2]: https://github.com/sixafter/nanoid/compare/v1.17.1...v1.17.2
 [1.17.1]: https://github.com/sixafter/nanoid/compare/v1.17.0...v1.17.1
 [1.17.0]: https://github.com/sixafter/nanoid/compare/v1.16.1...v1.17.0
 [1.16.1]: https://github.com/sixafter/nanoid/compare/v1.16.0...v1.16.1

diff --git a/README.md b/README.md
@@ -209,7 +209,7 @@ func main() {
 	}
 
 	// Generate a Nano ID using the custom generator
-	id, err := gen.New(21)
+	id, err := gen.New(nanoid.DefaultLength)
 	if err != nil {
 		fmt.Println("Error generating Nano ID:", err)
 		return
@@ -279,7 +279,7 @@ BenchmarkGenerator_Read_Concurrent/Concurrency_8-16                	71823493
 BenchmarkGenerator_Read_Concurrent/Concurrency_16-16               	74829878	        14.44 ns/op	      24 B/op	       1 allocs/op
 BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen8-16             	26380341	        45.18 ns/op	       8 B/op	       1 allocs/op
 BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen16-16            	19585760	        62.57 ns/op	      16 B/op	       1 allocs/op
-BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen21-16            	^[16327316	        71.70 ns/op	      24 B/op	       1 allocs/op
+BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen21-16            	16327316	        71.70 ns/op	      24 B/op	       1 allocs/op
 BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen32-16            	12858915	        92.76 ns/op	      32 B/op	       1 allocs/op
 BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen64-16            	 7864554	       152.7 ns/op	      64 B/op	       1 allocs/op
 BenchmarkNanoIDGeneration/ASCII_AlphabetLen2/IDLen128-16           	 4521963	       263.0 ns/op	     128 B/op	       1 allocs/op
@@ -469,4 +469,3 @@ Contributions are welcome. See [CONTRIBUTING](CONTRIBUTING.md)
 ## License
 
 This project is licensed under the [Apache 2.0 License](https://choosealicense.com/licenses/apache-2.0/). See [LICENSE](LICENSE) file.
-
diff --git a/SECURITY.md b/SECURITY.md
@@ -6,4 +6,4 @@ Patches will be released to the latest major version.
 
 ## Reporting a Vulnerability
 
-Please report (suspected) security vulnerabilities to security@sixafter.com. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
+Please report (suspected) security vulnerabilities to [security@sixafter.com](mailto:security@sixafter.com). If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ Patches will be released to the latest major version.

		## Reporting a Vulnerability

		Please report (suspected) security vulnerabilities to security@sixafter.com. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
		Please report (suspected) security vulnerabilities to [security@sixafter.com](mailto:security@sixafter.com). If the issue is confirmed, we will release a patch as soon as possible depending on complexity.