Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JSDoc Type Syntax and Parameter Naming #264

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

savvar9991
Copy link
Contributor

@savvar9991 savvar9991 commented Jan 2, 2025

1. JSDoc Type Syntax Fix:

{Map<string,string} - {Map<string,string>}

Change: Added missing > in type definition
Explanation: Fixed JSDoc syntax by adding the missing closing angle bracket in the Map type definition
Impact of the typo:
IDE type checking may fail or work incorrectly
Documentation generators might fail to parse the type
TypeScript compilation could fail if using TypeScript
Auto-completion features might not work properly
Could cause confusion for other developers reading the code

2. JSDoc Parameter Description:

Change: Fixed typo in dereferncer → dereferencer

Explanation: Corrected the misspelling where 'n' and 'c' were transposed


This change is Reviewable

@ArielElp ArielElp self-requested a review January 12, 2025 11:05
Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @savvar9991)

@ArielElp ArielElp merged commit 2030a65 into starkware-libs:master Jan 12, 2025
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.

2 participants