Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEBT: Documentation corrections and errata #33

Merged
merged 3 commits into from
Nov 12, 2024
Merged

DEBT: Documentation corrections and errata #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71d9304
DEBT: Documentation cleanup
mprimeaux Nov 12, 2024
6bf40e1
Update CHANGELOG
mprimeaux Nov 12, 2024
0f9adca
Minor doc updates
mprimeaux Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion CHANGELOG/CHANGELOG-1.x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
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.
Loading