Greeter #3
Open
Greeter #3
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
|
/review |
ghost
reviewed
Feb 28, 2023
There was a problem hiding this comment.
Review summary
Thanks for the PR 🙏
Critical PR sections
- [class-naming] detected in
my_lib/users.py:L9 - [interface-deprecation] detected in
my_lib/users.py:L9
PR overview
- 1 comment about [class-naming]
- 1 comment about [interface-deprecation]
Add the following reactions to this comment to let us know if:
- 😕 the review missed something important
|
|
||
|
|
||
| def greet_contributor(name: str) -> str: | ||
| """Creates a string message to greet the contributor. | ||
| class userGreeter: |
There was a problem hiding this comment.
Let's use the regular PascalCase convention for classes
Pattern explanation 👈
Check here for reference.Replacement example
Here is an example of how you could handle this:
class ModuleParser:
def __init__(self, path: Path) -> None:
self.path = pathThis comment is about [class-naming]. Add the following reactions on this comment to let us know if:
- 👀 that doesn't seem right
- 👎 this isn't important for you right now
- 😕 that explanation wasn't clear
|
|
||
|
|
||
| def greet_contributor(name: str) -> str: |
There was a problem hiding this comment.
This renaming seems to be introducing a breaking change 😅
Pattern explanation 👈
Breaking changes are modifications of the code base that can cause crashes for a reliant piece of code that hasn't been updated. Check here for reference.This comment is about [interface-deprecation]. Add the following reactions on this comment to let us know if:
- 👀 that doesn't seem right
- 👎 this isn't important for you right now
- 😕 that explanation wasn't clear
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.
st'