zaida04 / guilded.js

A library for creating bots with the guilded.gg bot API.
https://guilded.js.org
MIT License
69 stars 15 forks source link

feat: adding jsdoc @example to popular methods #219

Closed JMTK closed 1 year ago

JMTK commented 1 year ago

Please describe the changes this PR makes and why it should be merged: Starts work to resolve #158 although it will be an ongoing thing I presume image

Also @zaida04 any qualms with me starting a CONTRIBUTING.md?

Status

Semantic versioning classification:

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: f6d90a68c5b7303e6e7d797a8c0e4f452d4cd7f4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

zaida04 commented 1 year ago

Thanks for the PR!

As for the CONTRIBUTING.me, we do have one at https://github.com/guildedjs/guilded.js/blob/main/.github/CONTRIBUTING.md, but we welcome any changes you may have for it.

zaida04 commented 1 year ago

Also one thing to be aware, don't include types in your @param jsdoc comments. We use tsdoc, which auto extracts the types from the inline typescript types.

zaida04 commented 1 year ago

Thank you for the PR!