Conform one line comments to PEP8 #68
Open
Conversation
This file contains hidden or 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
Improves code readability
ammarmallik
suggested changes
Nov 5, 2019
|
|
||
| def get_event(string): | ||
| """Returns the event""" | ||
| # Returns the event |
Contributor
There was a problem hiding this comment.
Revert this everywhere in the file. This is called docstring. Please read: [https://www.python.org/dev/peps/pep-0257/#id16](One line docstring)
|
|
||
| def get_details(event): | ||
| """Returns the details of the event according to the type of the event""" | ||
| # Returns the details of the event according to the type of the event |
|
|
||
| def check_for_fork(link, user): | ||
| """Check whether it is a forked.""" | ||
| # Check whether it is a fork |
|
|
||
| def get_local_time(string): | ||
| """Returns the local time.""" | ||
| # Returns the local time |
|
|
||
| def get_following_users(user): | ||
| """prints the users followed by current user""" | ||
| # prints the users followed by current user |
|
|
||
| def get_basic_info(user): | ||
| """Prints the user's basic info.""" | ||
| # Prints the user's basic info |
|
|
||
| def convert_to_local(string): | ||
| """Returns the local_stamp as string.""" | ||
| # Returns the local_stamp as string |
|
|
||
| def update(): | ||
| """Runs the upgrade command and upgrades git-stalk""" | ||
| # Runs the upgrade command and upgrades git-stalk |
|
|
||
| def filter_since_until_dates(events, since_date=None, until_date=None): | ||
| """Filters the events based on since and until dates""" | ||
| # Filters the events based on since and until dates |
|
|
||
| def get_dates_from_arguments(arguments): | ||
| """Return triplet of dates from given arguments.""" | ||
| # Return triplet of dates from given arguments |
Contributor
|
Remove conflicts as well. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Improves code readability