the docstrings added at the begening and the end#111
the docstrings added at the begening and the end#111Chrizz-coder wants to merge 1 commit intowesdoyle:masterfrom
Conversation
|
just review it |
There was a problem hiding this comment.
Pull request overview
This PR adds additional docstring-like text to the constants module and introduces a new constants.py~ file alongside the existing constants.py.
Changes:
- Added extra triple-quoted string blocks near the top and bottom of
constants.py. - Added a new
constants.py~file containing a copy of constants definitions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| constants.py | Adds additional triple-quoted string blocks at the beginning and end of the module. |
| constants.py~ | Introduces a new backup-like file containing constants definitions (currently not valid Python due to indentation). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| """ | ||
| there is going to be | ||
| some changes | ||
| """ |
There was a problem hiding this comment.
The added triple-quoted block is a standalone string literal (not the module docstring) and will be treated as a no-op statement at import time. If this is meant to document the module, merge it into the initial module docstring; otherwise convert it to # comments or remove it.
| SHELTER_IN_PLACE | ||
| ] | ||
|
|
||
| """this is the end..""" |
There was a problem hiding this comment.
This trailing triple-quoted string is another standalone string literal and doesn’t function as a docstring (it also adds unnecessary trailing whitespace on the preceding blank line). It should be removed, or replaced with a comment if you need an end-of-file marker (generally not needed).
| """this is the end..""" |
| """ | ||
| Simulation Constants | ||
| """ |
There was a problem hiding this comment.
This appears to be an editor/backup file (the ~ suffix). It’s generally best to avoid committing these; please remove it from version control and add an ignore pattern like *~ to .gitignore so it won’t be re-added accidentally.
| class SimColor: | ||
| """ | ||
| Tuples corresponding to RGB colors | ||
| """ |
There was a problem hiding this comment.
The class docstring is not indented under class SimColor:. In Python this causes an IndentationError (expected an indented block after the class definition). Indent the docstring (and any other class-level docstrings in this file) to be inside the class body.
1 participant
just made any update on the file constants.py for learning purposes.