Skip to content

docs(library): document config validation errors - #427

Merged
TMHSDigital merged 1 commit into
TMHSDigital:mainfrom
harshit3355:docs/415-document-config-validation
Nov 17, 2026
Merged

TMHSDigital merged 1 commit into
TMHSDigital:mainfrom
harshit3355:docs/415-document-config-validation

Conversation

@harshit3355

Copy link
Copy Markdown
Contributor

Description

Document Config.Validate() and the ErrNoWords sentinel in the Go library guide, and tag both identifiers as unreleased so the page labels them consistently with the rest of the API.

Related Issue

Closes #415

Type Change

  • Bug fix (non-breaking change fixes an issue)
  • New feature (non-breaking change adds functionality)
  • Breaking change (fix or feature would cause existing functionality not to work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvements
  • Test updates

Checklist

  • I read the CONTRIBUTING document
  • My code follows this project's code style
  • I added/updated appropriate comments in the code
  • I added tests to prove my fix is effective or feature works
  • New and existing unit tests pass locally with my changes
  • I updated documentation accordingly (if applicable)

Ethical Considerations

  • This change maintains or improves security controls in the tool
  • This change follows the project's educational/legitimate security testing focus
  • I considered potential misuse cases and took appropriate steps to prevent them

Additional Information

git diff --check passes. Go tests and a local Jekyll build were not run for this documentation-only change. Template confirmations are left unchecked for the contributor to review.

@TMHSDigital
TMHSDigital marked this pull request as ready for review November 17, 2026 12:19
@TMHSDigital
TMHSDigital merged commit e1cb20a into TMHSDigital:main Nov 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/library.md omits Config.Validate and ErrNoWords

2 participants