Improve JSDocs by adding examples of usages

[ivpavici]

Inspired by Viem docs, example:

https://viem.sh/docs/accounts/privateKey#usage

This is a big endeavor so it can be completed in multiple smaller PR-s (and more users can take it in parallel!)

IMPORTANT: add @example only to exported functions

TODO utils:

• src/utils/calldata/validate
• src/utils/calldata/formatter
• src/utils/calldata/propertyOrder
• src/utils/calldata/requestParser
• src/utils/calldata/responseParser
• src/utils/calldata/tuple
• src/utils/calldata/parser/index.ts
• src/utils/events/index.ts
• src/utils/hash/classHash.ts
• src/utils/hash/transactionHash/v3.ts

[ivpavici]

Users please pick one part of the docs which you want to work on and write here for everyone else to know!

[elielnfinic]

Hey @ivpavici, could you please specify on which elements examples should be added ?

[Ayoazeez26]

I would love to take the signature part of the docs

[Jemiiah]

if this work isn't assigned to anybody, can i get it, @ivpavici ?

[ivpavici]

hi all!

To explain a bit more, we are not talking about rewriting Guides (like https://www.starknetjs.com/docs/guides/create_account) but adding examples to JSdocs in the code, how they can be used, for example on utils:

which looks like this:

[ivpavici]

This means you need to try out, play and test some parts of the code, to see how it works and then add an example.
Some of them can be for sure found in tests and will be easy to solve!

[ivpavici]

@Jemiiah no need to assign since multiple people can work on it... pick a part of the code (please write here which) and send a PR with this issue linked

[Ugo-X]

Hello @ivpavici would like to handle the Estimate fees segment, if there's no need for an assignment won't there be a clash at some point?