added documentation, shoutoutAPI #579
Merged
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
|
[diff-counting] Significant lines: 24. |
oscarwang20
requested changes
Feb 12, 2024
backend/src/API/shoutoutAPI.ts
Outdated
| export const getAllShoutouts = (): Promise<Shoutout[]> => shoutoutsDao.getAllShoutouts(); | ||
|
|
||
| /** | ||
| * Gives a shoutout, ensuring the giver has the correct permissions. |
There was a problem hiding this comment.
I would change "Gives" to "Create" here
andrew032011
requested changes
Feb 12, 2024
There was a problem hiding this comment.
I find it a bit redundant to mention permissions in the docstring. I think in general it is implied. If we want to include info about permissions here, we should be more specific as to what we're checking. Otherwise, I might remove it (you can keep the @throws).
Also soon we'll have an auth model that takes care of some of this logic.
andrew032011
approved these changes
Mar 4, 2024
oscarwang20
approved these changes
Mar 4, 2024
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.
added documentation to shoutoutAPI- documenting the purpose and usage of each method within the class.