jsdoc: Add jsdoc for loadData API #204
Conversation
✅ Deploy Preview for racingbars ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
| Playground | Link |
|---|---|
| JavaScript (ESM) | https://livecodes.io?x=code/N4IgLglmA2CmIC4QCkCGA3... |
| JavaScript (UMD) | https://livecodes.io?x=code/N4IgLglmA2CmIC4QCkCGA3... |
| React | https://livecodes.io?x=code/N4IgLglmA2CmIC4QCVYEMD... |
| Svelte | https://livecodes.io?x=code/N4IgLglmA2CmIC4QGUButp... |
| TypeScript | https://livecodes.io?x=code/N4IgLglmA2CmIC4QBUCeAH... |
| Vue | https://livecodes.io?x=code/N4IgLglmA2CmIC4QDUCu8A... |
See documentations for usage instructions.
|
Hello @hatemhosny, I’ve added JSDoc comments for loadData. Could you please review them and let me know if you have any suggestions or changes? I’d like to keep these in mind as I document the rest of the API. I think this will help me get a better grasp of the code! 😄 |
|
That's beautiful, @AhmedElbohoty |
|
you probably want to start with these: |
|
Also, please remove this, so that comments will end up in the exported types. |
AhmedElbohoty
force-pushed
the
jsdoc
branch
from
e0f17cf
to
840fd67
Compare
|
You can now see your comments in the preview playgrounds above 🎉
These comments can significantly improve the developer experience of the library users. |
|
Hello @hatemhosny, Sorry for the delay 🙏. I was really busy last month, but I’ll resume documenting the code |
|
No worries, @AhmedElbohoty |
|
|
Can we please keep this PR for JS Docs only and not add refactors that we have not agreed upon? P.S. I frequently use early return pattern and I do not currently plan to change it. |
What kind of change does this PR introduce?
Docs
Issue related to this PR
173
Add JSDoc comments for public-facing API #173