-
Notifications
You must be signed in to change notification settings - Fork 754
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
cleanup and docs update, string types descriptive #747
Conversation
✅ Deploy Preview for starknetjs canceled.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noticed that some of the JSDOC/TSDOC comment elements clash with the autogenerated content. I'll open a PR targeting this branch with the corresponding tweaks.
src/utils/shortString.ts
Outdated
* @returns a string representing an Hex number 248 bits max. | ||
* @Example | ||
* ```typescript | ||
* const myEncodedString: string = encodeShortString("uri/pict/t38.jpg"); | ||
* ``` | ||
* returns : string : "0x7572692f706963742f7433382e6a7067" | ||
* return hex string (ex."0x7572692f706963742f7433382e6a7067") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* return hex string (ex."0x7572692f706963742f7433382e6a7067") | |
* return hex string (ex. "0x7572692f706963742f7433382e6a7067") |
src/utils/shortString.ts
Outdated
* @Example | ||
* ```typescript | ||
* const myDecodedString: string = decodeShortString("0x7572692f706963742f7433382e6a7067"); | ||
* ``` | ||
* return : string : "uri/pict/t38.jpg" | ||
* return string (ex."uri/pict/t38.jpg") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* return string (ex."uri/pict/t38.jpg") | |
* return string (ex. "uri/pict/t38.jpg") |
docs: tweak tsdoc elements
Co-authored-by: Ivan Pavičić <[email protected]>
🎉 This PR is included in version 5.19.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Fix #742
Fix #724
Motivation and Resolution
Checklist: