jsdoc: Add jsdoc for loadData API

hatemhosny / racing-bars

Bar chart race made easy 🎉

https://racing-bars.hatemhosny.dev/

MIT License

75 stars 4 forks source link

jsdoc: Add jsdoc for loadData API #204

Open AhmedElbohoty opened 2 months ago

AhmedElbohoty commented 2 months ago

What kind of change does this PR introduce? Docs

Issue related to this PR 173

issue link: https://github.com/hatemhosny/racing-bars/issues/173

netlify[bot] commented 2 months ago

Deploy Preview for racingbars ready!

Name	Link
Latest commit	0507ec26846729a83cd7f6596d33a0b768f2efb3
Latest deploy log	https://app.netlify.com/sites/racingbars/deploys/670cf27c187c4b00085191b1
Deploy Preview	https://deploy-preview-204--racingbars.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions[bot] commented 2 months ago

Preview in LiveCodes

Latest commit: 0507ec26846729a83cd7f6596d33a0b768f2efb3
Last updated: Oct 14, 2024 10:29am (UTC)

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.

AhmedElbohoty commented 2 months ago

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! 😄