Typo + syntax errors #345
Merged
Typo + syntax errors #345
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
smorimoto
approved these changes
Dec 1, 2025
There was a problem hiding this comment.
Pull request overview
This PR fixes spelling and grammar errors in documentation comments across the TyXML library. It cherry-picks typo and syntax corrections from PR #343, focusing on improving the clarity and correctness of API documentation.
Key Changes:
- Fixed typo "subressource" → "subresource" in type name and all references
- Standardized compound adjectives with proper hyphenation (e.g., "space separated" → "space-separated")
- Improved consistency in documentation style across HTML and SVG signature files
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| lib/svg_sigs.mli | Updated documentation comments to use "space-separated" and "comma-separated" with proper hyphenation |
| lib/html_types.mli | Fixed "subressource_integrity" typo to "subresource_integrity" in type definition and all references; changed "white space separated" to "whitespace-separated" |
| lib/html_sigs.mli | Updated documentation comments to use "space-separated" and "comma-separated" with proper hyphenation |
| CHANGES.md | Added changelog entry documenting the typo fixes for the next release |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Cherry-picking typos & syntax mistakes from #343
1
Footnotes
Please consider giving up MS GitHub or offering a non-proprietary, non-US-corporate-controlled mirror for this free software project. I wish to delete this Microsoft account in the future, but I need more projects like this to support alternative methods to send patches & contribute. ↩