add documentation to TeamEventsDao #511
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: 21. |
alyssayzhang
changed the title
andrew032011
approved these changes
Sep 29, 2023
backend/src/dao/TeamEventsDao.ts
Outdated
| static async deleteTeamEvent(teamEvent: TeamEventInfo): Promise<void> { | ||
| const eventDoc = teamEventsCollection.doc(teamEvent.uuid); | ||
| const eventRef = await eventDoc.get(); | ||
| if (!eventRef.exists) throw new NotFoundError(`No team event '${teamEvent.uuid}' exists.`); | ||
| await eventDoc.delete(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a team event | ||
| * @param event - newly created TeamEvent object that represent the details of the event |
There was a problem hiding this comment.
nit: TeamEventInfo? Or just write "team event" like you did for the other endpoints to be consistent. The confusion here is that it's now implying that the type of the parameter is TeamEvent.
There was a problem hiding this comment.
changing it rn to TeamEventInfo!
andrew032011
approved these changes
Sep 29, 2023
alyssayzhang
deleted the
alyssazhang/add-documentation-to-team-events-dao
branch
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.
Summary
TeamEventsDao.ts