style: Advertise underscore_separation for function names #265
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
Saransh-cpp
requested changes
Nov 29, 2024
Co-authored-by: Saransh Chopra <[email protected]>
Saransh-cpp
approved these changes
Nov 29, 2024
|
Thank you @Saransh-cpp, seems the build failed due to a key, I see similar PR before can skip this steps but I do not have access to trigger the build, would you please help merge this? Thank you. |
Saransh-cpp
requested changes
Dec 2, 2024
There was a problem hiding this comment.
Hi, @zhaohany! Please don't worry about the CI. The CI is failing because this PR is from a fork. A minor comment that I missed before -
Comment on lines
-135
to
-143
| # %% [markdown] | ||
| # This other example uses underscore_separation for all the names. | ||
|
|
||
| # %% | ||
| class class_name: | ||
| def method_name(a_variable): | ||
| m_instance_variable = a_variable | ||
|
|
||
|
|
There was a problem hiding this comment.
I would keep this as it is (a possible but not a recommended use-case).
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.
This PR updates the naming conventions section to promote the use of
underscore_separationfor function names, in alignment with [PEP 8](https://pep8.org/) guidelines.Fixes issue: [UCL/rsd-engineeringcourse#263](#263)