feat: add jsdoc descriptions to the helpers

[ovindu-a]

Description

I have added jsdoc comments that include a description, example and linked the docs page.

Issue Ticket Number

Fixes #144 (add jsdoc descriptions to the helpers)

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Fix or improve the documentation
• This change requires a documentation update

Checklist

• I have followed the contributing guidelines of this project as mentioned in CONTRIBUTING.md
• I have created an issue ticket for this PR
• I have checked to ensure there aren't other open Pull Requests for the same update/change?
• I have performed a self-review of my own code
• I have run tests locally to ensure they all pass
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes needed to the documentation

[changeset-bot]

🦋 Changeset detected

Latest commit: 44c3bad

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
svelte-cloudinary	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

@ovindu-a is attempting to deploy a commit to the Cloudinary DevX Team on Vercel.

A member of the Team first needs to authorize it.

[ghostdevv]

only some minor tweaks then LGTM! Could you add a changeset, for this. it can be marked as a minor and have a message like feat: add jsdoc descriptions to the helpers

https://github.com/cloudinary-community/svelte-cloudinary/blob/main/CONTRIBUTING.md#changesets

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
svelte-cloudinary	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 2, 2024 0:37am

[ghostdevv]

Looks like there are some lint errors, you can run pnpm format to fix those

[ghostdevv]

sorry, one more thing 😅 (+ the pnpm format)

[ovindu-a]

@ghostdevv , shall I make a new pull request with the changes?

[ghostdevv]

@ovindu-a you can update this one!

[ovindu-a]

@ghostdevv I am having an issue when adding the changeset.

error Error: Failed to find where HEAD diverged from main. Does main exist

[ghostdevv]

hmm, looks like you're not on your branch issue-144, try running

git reset origin/main --hard
git checkout issue-144
git pull

[ovindu-a]

Thank you @ghostdevv, I have made the new commit

[ghostdevv]

perfect, ty!

[colbyfayock]

hey @ovindu-a thanks for the contribution! This merged PR is eligible for some free swag from Cloudinary.

Please send an email over to hacktoberfest@cloudinary.com with your name, GitHub username, and link to the PR where I'll provide you with the next steps for claiming your swag.

Happy Hacktoberfest!

[ovindu-a]

Woahh that's cool @colbyfayock, I just sent you an email. A special thanks to @ghostdevv for guiding me through the process!