Event logic comments #1215
Closed
Event logic comments #1215
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
method in events.py
and docstrings of all functions in events.py
WackyWeaver
reviewed
Jul 3, 2024
| """ | ||
| #lists program identifying numbers with their corresponding events saved in the DB | ||
| #sorted by date and time | ||
| #student led programs included Berea Buddies(program 2) and adopt a grandparent (program 3) |
There was a problem hiding this comment.
Could be a block comment if there need to be 3 lines
|
It looks pretty good, but there are few changes I would make if I was you. Most of the comments do not have a space between the hashtag and the first word. Also, some of the method comments are filled with redundant information. |
|
Going to close this. Generally looks good but I think a lot of the comments may actually be overkill. Will keep this linked in the issue as it is a great reference but will likely not get merged. |
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.
Updated many docstrings and comments in events.py. Added docstrings and many comments to improve code readability.