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 includes updates to the
README.md
file, version bump inpackage.json
, and extensive additions of documentation comments across several TypeScript files to improve code clarity and maintainability.Documentation Enhancements:
src/structures/IOpenApiSchemaError.ts
: Added detailed documentation comments to describe theIOpenApiSchemaError
interface and its members.src/typings/IResult.ts
: Added documentation comments to explain theIResult
type and its success and failure interfaces.Type Checker Documentation:
src/utils/ChatGptTypeChecker.ts
: Added documentation comments for various type-checking functions such asisNull
,isUnknown
,isBoolean
, etc., and for operators likevisit
andcovers
. [1] [2] [3]src/utils/GeminiTypeChecker.ts
: Added documentation comments for type-checking functions and operators similar to those inChatGptTypeChecker
. [1] [2] [3]src/utils/LlmTypeCheckerV3_1.ts
: Added documentation comments for type-checking functions and operators, includingisNull
,isUnknown
,isConstant
, andvisit
. [1] [2] [3]README Updates:
next
version and updated the npm install command to remove the--tag next
flag. [1] [2]Version Update:
package.json
: Updated the version from2.0.0-dev.20241202-2
to2.0.0
.