From 404f01b81a937370af5cb145ef1d813901cb43c3 Mon Sep 17 00:00:00 2001 From: Helen Lei Date: Sun, 22 Oct 2023 19:10:38 -0400 Subject: [PATCH] fix docstrings that aren't correct --- server/endpoints/Profile.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/server/endpoints/Profile.ts b/server/endpoints/Profile.ts index 63b426201..5da582007 100644 --- a/server/endpoints/Profile.ts +++ b/server/endpoints/Profile.ts @@ -45,7 +45,8 @@ export const getStudentEmailByToken: Endpoint = { }; /** - * Returns the number of reviews that match a given netId and null if there are none + * Returns the number of reviews that match a given netId or a message if there + * are no none * This method counts the total number of reviews left by a student. * @param netId: netId that is checked to see if it is not empty and an ASCII value * @returns: Endpoint with type NetIdQuery @@ -73,7 +74,7 @@ export const countReviewsByStudentId: Endpoint = { /** * Returns the number of likes that match the reviewIds associated with a given - * netId and error if there are none + * netId or throws an error if the netId doesn't exist * This method calculates the total number of likes a student has received on all their reviews. * @param netId: netId that is checked to see if it is not empty and an ASCII value * @returns: Endpoint with type NetIdQuery @@ -110,8 +111,8 @@ export const getTotalLikesByStudentId: Endpoint = { }; /** - * Returns the reviews that match the reviewIds associated with a given netId and - * error if there are none + * Returns the reviews that match the reviewIds associated with a given netId or + * throws an error if the netId doesn't exist * This method gets all of the reviews created by a student. * @param netId: netId that is checked to see if it is not empty and an ASCII value * @returns: Endpoint with type NetIdQuery