chore: add documentation for starknetid.ts #1115
Closed
Conversation
This file contains 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
ivpavici
reviewed
May 2, 2024
ivpavici
reviewed
May 3, 2024
| @@ -24,6 +24,12 @@ function extractStars(str: string): [string, number] { | |||
| * Decodes an array of BigInts into a string using the given algorithm. | |||
| * @param {bigint[]} encoded - The encoded array of BigInts. | |||
| * @return {string} The decoded string. | |||
| * @example | |||
There was a problem hiding this comment.
@irisdv can you please confirm if these example's look ok?
tabaktoni
added
the
Type: documentation
ivpavici
reviewed
May 6, 2024
| @@ -96,6 +108,13 @@ export function signatureToHexArray(sig?: Signature): ArraySignatureType { | |||
|
|
|||
| /** | |||
| * Convert estimated fee to max fee with overhead | |||
| * @param {BigNumberish} estimatedFee - The estimated fee | |||
| * @param {number} [overhead = feeMarginPercentage.MAX_FEE] - The overhead added to the gas | |||
| * @returns {bigint} The maximum fee with overhead | |||
PhilippeR26
requested changes
May 7, 2024
There was a problem hiding this comment.
Nearly good, but as explained in Telegram https://t.me/c/2066195975/59 ,
please follow very rigorously the template of this PR #1100, especially for the examples : result always in a result variable, result displayed in a comment (//) (no assert).
|
Reviews fixed @PhilippeR26 |
PhilippeR26
requested changes
May 14, 2024
There was a problem hiding this comment.
Is it normal to have no examples or missing @returns in some areas :
starks.ts : L79-106, L168-242 ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation and Resolution
Closes #1090
RPC version (if applicable)
...
Usage related changes
Development related changes
Checklist: