-
Notifications
You must be signed in to change notification settings - Fork 704
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
Improve JSDocs by adding examples of usages #1090
Comments
Users please pick one part of the docs which you want to work on and write here for everyone else to know! |
Hey @ivpavici, could you please specify on which elements examples should be added ? |
I would love to take the signature part of the docs |
if this work isn't assigned to anybody, can i get it, @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: |
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. |
@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 |
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? |
@Ugo-X I will consider PR-s from contributors who announce the parts up front. |
Hi @ivpavici I will love to work on typeData.ts and json.ts |
Hello I would like to contribute, I hope I understood well the task, I will try to write the exemples of the address.ts file. |
@ivpavici can i work on TS Config.json and signer/interface.ts |
PR by @BlackStarkGoku is a good example to take a look in what direction we want to go: |
Perfect thanks @ivpavici then I will add more such as encode.ts, num.ts |
ok, please @BlackStarkGoku can you leave num.ts to @NueloSE |
Ok I will just do encode.ts for now |
@ivpavici can i work on shortString.ts and transaction.ts |
@NueloSE thanks! go for it! |
Can I go with stark.ts, starknetid.ts, and connect.ts |
Hi, @ivpavici can I work on index.ts and propertyOrder.ts |
hey all! |
🎉 This issue has been resolved in version 6.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Hey @ivpavici, Just wanted to confirm if we are still open to add docs in the code. If yes, I will start on testing some functions and add documentation to it. I had a look at the code and saw some undocumented functions in shortString.ts. So, if you allow I will start to look for more, test them out, add docs and examples to them. |
@KeneePatel hello! in the |
@ivpavici ,can I take on transaction.test.ts and contract.test.ts |
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!)
The text was updated successfully, but these errors were encountered: