Add profile documentation #412
Conversation
|
[diff-counting] Significant lines: 26. |
There was a problem hiding this comment.
Hey Helen, nice job addressing the changes that Michelle requested. I noticed that you just have some things in the docstrings that might not be totally correct. For some of the docstrings, you state that the function will throw an error "if there are none", but this isn't necessarily accurate. For example. getTotalLikesByStudentId will just return a message with totalLikes = 0 and not throw an error. Did you mean if the findOne methods didn't find a document, then they would return null, or it would error if let's say the netId did not exist?
server/endpoints/Profile.ts
Outdated
| * [getTotalLikesByStudentId] returns the total number of likes a student has gotten on their reviews | ||
| * Returns the number of likes that match the reviewIds associated with a given | ||
| * netId and error if there are none | ||
| * This method counts the total number of likes received by a student. |
There was a problem hiding this comment.
hey Helen, nice work! I think here we should change "This method counts the total number of likes received by a student." to "This method calculates the total number of likes a student has received on all their reviews." to be a little more clear
changed the documentation in Profile.ts