Documentation comments on tags. #1634
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive JSDoc documentation to all validation tag types in the src/tags directory. The documentation provides detailed explanations of each tag's purpose, usage examples, constraints, and relationships with other tags to improve developer experience and code maintainability.
- Added JSDoc comments to 19 tag types with detailed descriptions, usage examples, and author attribution
- Documented mutual exclusivity constraints between related tags (e.g., Maximum vs. ExclusiveMaximum)
- Included practical code examples showing real-world usage scenarios for each validation tag
Reviewed Changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| TagBase.ts | Added foundational documentation explaining the base type for all validation tags |
| Constant.ts | Documented tag for adding metadata to literal types with title/description |
| ContentMediaType.ts | Added documentation for MIME type specification tag |
| Default.ts | Documented default value assignment tag for optional properties |
| Example.ts | Added documentation for single example value tag |
| Examples.ts | Documented multiple named examples tag |
| ExclusiveMaximum.ts | Added documentation for strict maximum constraint tag |
| ExclusiveMinimum.ts | Documented strict minimum constraint tag |
| Format.ts | Added documentation for predefined string format validation |
| JsonSchemaPlugin.ts | Documented custom JSON Schema property injection tag |
| Maximum.ts | Added documentation for inclusive maximum constraint tag |
| MaxItems.ts | Documented array maximum length validation tag |
| MaxLength.ts | Added documentation for string maximum length constraint |
| Minimum.ts | Documented inclusive minimum constraint tag |
| MinItems.ts | Added documentation for array minimum length validation tag |
| MinLength.ts | Documented string minimum length constraint tag |
| MultipleOf.ts | Added documentation for numeric multiple constraint tag |
| Pattern.ts | Documented regular expression validation tag |
| Sequence.ts | Added documentation for Protocol Buffer field numbering tag |
| Type.ts | Documented numeric bit-width representation tag |
| UniqueItems.ts | Added documentation for array uniqueness validation tag |
commit: |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds comprehensive JSDoc documentation to all validation tag types in the
src/tagsdirectory. The new comments explain the purpose, usage, and examples for each tag, improving code readability and making it easier for developers to understand and use these tags correctly. The documentation also highlights important constraints and relationships between tags (such as mutual exclusivity), and provides author attribution.The most important changes are grouped below:
Core Documentation Improvements
Constant,Default,Example,Examples,ExclusiveMaximum,ExclusiveMinimum,Format,JsonSchemaPlugin,MaxItems,MaxLength,Maximum,MinItems,MinLength,Minimum,MultipleOf,Pattern,Sequence, andTagBase). Each comment explains the tag's purpose, usage, supported types, and includes practical code examples. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]TagBase Foundation
TagBasetype and itsIPropsinterface, describing their role as the foundation for all validation tags and providing a custom tag example. [1] [2]Usage Guidance and Constraints
Maximumvs.ExclusiveMaximum,Minimumvs.ExclusiveMinimum,Formatvs.Pattern) to help prevent incorrect usage. [1] [2] [3] [4] [5] [6]Practical Examples
Author Attribution
@authorattribution for Jeongho Nam in all new documentation comments. (All tag documentation changes)These changes significantly improve the developer experience by making the validation tags self-documenting and easier to discover and use correctly.