Added missing (and improved existing) function documentation, Improved error message clarity #88
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Elitezen
commented
Oct 17, 2023
Elitezen
commented
- I added additional information to the JSDocs of certain functions, improved descriptions for functions and their parameter/options.
- Reworded error messages for more clarity.
…f the existing documentation
✅ Deploy Preview for topgg-node-sdk-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jpbberry
requested changes
Apr 8, 2024
src/structs/Api.ts
Outdated
| return this._request("GET", `/bots/${id}`); | ||
| } | ||
|
|
||
| /** | ||
| * Get user info | ||
| * Retrieves information about a particular user by their Discord user id. |
There was a problem hiding this comment.
Don’t want to tie the User ID to only Discord user IDs. Right now this may be the case but in general it’s a top.gg ID. Can you reword this
Also can you capitalize ID
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.