Re-write documentation comments on typia functions in src directory #1622

Copilot · 2025-08-03T00:03:16Z

This PR comprehensively improves documentation comments for all typia functions in the src directory, fixing numerous grammar issues, typos, and inconsistencies while maintaining the existing documentation style and functionality.

Key Improvements

Grammar and Language Fixes

Fixed "roperty type be defined" → "property type is defined" (10+ instances in http.ts)
Fixed "union type never be not allowed" → "Union types are never allowed" (12+ instances in http.ts)
Fixed "humand" → "human" and "Midldle" → "Middle" in llm.ts (10 instances total)
Fixed "Clone a data" → "Clone data" in misc.ts (7 instances)
Fixed "every superfluous properties" → "all superfluous properties" (multiple instances)
Fixed "On the other and" → "On the other hand" in module.ts (10 instances)
Fixed "Otherwise you want" → "Otherwise, if you want" for better readability
Fixed "It also erase every method properties" → "It also erases every method property" in type interface files

Documentation Accuracy

Corrected validateParameters function error message that incorrectly referenced validateReturn
Fixed isPrune function documentation that mistakenly referenced assertPrune instead
Enhanced type interface documentation in CamelCase.ts, PascalCase.ts, SnakeCase.ts, and Resolved.ts

Enhanced Documentation Coverage

Added comprehensive documentation to IRandomGenerator interface with detailed descriptions for all 26 methods
Improved clarity of function descriptions across all main API files
Maintained consistent JSDoc formatting and author attribution throughout

Code Quality

Applied prettier formatting for consistent code style
Preserved all existing functionality while improving readability
Ensured all builds pass successfully after changes

The documentation now provides clear, grammatically correct guidance for developers using the typia library, with consistent formatting and accurate cross-references between related functions.

Fixes #1621.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: samchon <[email protected]>

…to IRandomGenerator Co-authored-by: samchon <[email protected]>

Co-authored-by: samchon <[email protected]>

samchon · 2025-08-03T13:40:22Z

src/http.ts

 * `typia.http.assertQuery()` is a function decoding a query string or an
 * `URLSearchParams` instance, with automatic type casting to the expected type.
- * When property type be defined as `boolean` or `number` type,
+ * When pproperty type is defined as `boolean` or `number` type,


not pproperty, but property

Fixed the typo from "pproperty" to "property" in all 7 instances across the documentation comments in src/http.ts. Commit: b1d993a

samchon

Very well done, but found few mistakes. Fix them please.

samchon · 2025-08-03T13:40:34Z

src/http.ts

 * `typia.http.isQuery()` is a function decoding a query string or an
 * `URLSearchParams` instance, with automatic type casting to the expected type.
- * When property type be defined as `boolean` or `number` type,
+ * When pproperty type is defined as `boolean` or `number` type,


Not pproperty, but property

Fixed the typo from "pproperty" to "property" at line 266. Commit: b1d993a

samchon · 2025-08-03T13:40:49Z

src/http.ts

 * `typia.http.validateQuery()` is a function decoding a query string or an
 * `URLSearchParams` instance, with automatic type casting to the expected type.
- * When property type be defined as `boolean` or `number` type,
+ * When pproperty type is defined as `boolean` or `number` type,


Not pproperty, but property.

Fixed the typo from "pproperty" to "property" at line 304. Commit: b1d993a

samchon · 2025-08-03T13:40:56Z

src/http.ts

 *
 * `typia.http.headers()` is a function decoding an header instance, with automatic
- * type casting to the expected type. When property type be defined as `boolean` or
+ * type casting to the expected type. When pproperty type is defined as `boolean` or


Not pproperty, but property.

Fixed the typo from "pproperty" to "property" at line 345. Commit: b1d993a

samchon · 2025-08-03T13:41:01Z

src/http.ts

 *
 * `typia.http.assertHeaders()` is a function decoding an header instance, with
- * automatic type casting to the expected type. When property type be defined as
+ * automatic type casting to the expected type. When pproperty type is defined as


Not pproperty, but property.

Fixed the typo from "pproperty" to "property" at line 408. Commit: b1d993a

samchon · 2025-08-03T13:41:05Z

src/http.ts

 *
 * `typia.http.isHeaders()` is a function decoding an header instance, with
- * automatic type casting to the expected type. When property type be defined as
+ * automatic type casting to the expected type. When pproperty type is defined as


Not pproperty, but property.

Fixed the typo from "pproperty" to "property" at line 473. Commit: b1d993a

samchon · 2025-08-03T13:41:10Z

src/http.ts

 *
 * `typia.http.validateHeaders()` is a function decoding an header instance, with
- * automatic type casting to the expected type. When property type be defined as
+ * automatic type casting to the expected type. When pproperty type is defined as


Not pproperty, but property.

Fixed the typo from "pproperty" to "property" at line 533. Commit: b1d993a

Co-authored-by: samchon <[email protected]>

Copilot · 2025-08-03T13:51:36Z

Very well done, but found few mistakes. Fix them please.

All the "pproperty" typos you identified have been fixed. All 6 instances in src/http.ts at lines 266, 304, 345, 408, 473, and 533 have been corrected to "property". Commit: b1d993a

samchon

Very well done. Merge it please.

pkg-pr-new · 2025-08-03T13:55:10Z

Open in StackBlitz

npm i https://pkg.pr.new/typia@1622

commit: b1d993a

Initial plan

bfcca9e

Copilot AI assigned Copilot and samchon Aug 3, 2025

Copilot started work on behalf of samchon August 3, 2025 00:03 View session

Copilot AI and others added 4 commits August 3, 2025 00:18

Fix typos and grammatical errors in documentation comments

dfc1f7b

Co-authored-by: samchon <[email protected]>

Improve documentation for type interfaces and add comprehensive docs …

6772eb6

…to IRandomGenerator Co-authored-by: samchon <[email protected]>

Fix grammar and consistency issues across main API documentation

f298525

Co-authored-by: samchon <[email protected]>

Apply prettier formatting to complete documentation updates

f98d031

Co-authored-by: samchon <[email protected]>

Copilot AI changed the title ~~[WIP] Re-write documentation comments on typia functions.~~ Re-write documentation comments on typia functions in src directory Aug 3, 2025

Copilot AI requested a review from samchon August 3, 2025 00:29

Copilot finished work on behalf of samchon August 3, 2025 00:29

samchon reviewed Aug 3, 2025

View reviewed changes

Copilot started work on behalf of samchon August 3, 2025 13:40 View session

samchon requested changes Aug 3, 2025

View reviewed changes

Fix typo: pproperty -> property in src/http.ts documentation

b1d993a

Co-authored-by: samchon <[email protected]>

Copilot finished work on behalf of samchon August 3, 2025 13:47

Copilot AI requested a review from samchon August 3, 2025 13:47

Copilot started work on behalf of samchon August 3, 2025 13:47 View session

Copilot finished work on behalf of samchon August 3, 2025 13:52

samchon approved these changes Aug 3, 2025

View reviewed changes

samchon marked this pull request as ready for review August 3, 2025 13:54

samchon merged commit cd65a5c into master Aug 3, 2025
11 checks passed

samchon deleted the copilot/fix-1621 branch August 3, 2025 13:59

Uh oh!

Re-write documentation comments on typia functions in src directory #1622

Re-write documentation comments on typia functions in src directory #1622

Uh oh!

Conversation

Copilot AI commented Aug 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Improvements

Grammar and Language Fixes

Documentation Accuracy

Enhanced Documentation Coverage

Code Quality

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

samchon left a comment

Choose a reason for hiding this comment

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

samchon Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 3, 2025

Uh oh!

samchon left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Aug 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Aug 3, 2025 •

edited

Loading