Skip to content

Conform one line comments to PEP8#68

Open
tfidfwastaken wants to merge 1 commit into
aashutoshrathi:masterfrom
tfidfwastaken:patch-1
Open

Conform one line comments to PEP8#68
tfidfwastaken wants to merge 1 commit into
aashutoshrathi:masterfrom
tfidfwastaken:patch-1

Conversation

@tfidfwastaken

Copy link
Copy Markdown

Improves code readability

Improves code readability
Comment thread git_stalk/stalk.py

def get_event(string):
"""Returns the event"""
# Returns the event

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this everywhere in the file. This is called docstring. Please read: [https://www.python.org/dev/peps/pep-0257/#id16](One line docstring)

Comment thread git_stalk/stalk.py

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this.

Comment thread git_stalk/stalk.py

def check_for_fork(link, user):
"""Check whether it is a forked."""
# Check whether it is a fork

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

def get_local_time(string):
"""Returns the local time."""
# Returns the local time

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

def get_following_users(user):
"""prints the users followed by current user"""
# prints the users followed by current user

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

def get_basic_info(user):
"""Prints the user's basic info."""
# Prints the user's basic info

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

def convert_to_local(string):
"""Returns the local_stamp as string."""
# Returns the local_stamp as string

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

def update():
"""Runs the upgrade command and upgrades git-stalk"""
# Runs the upgrade command and upgrades git-stalk

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

Comment thread git_stalk/stalk.py

def get_dates_from_arguments(arguments):
"""Return triplet of dates from given arguments."""
# Return triplet of dates from given arguments

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

@ammarmallik

Copy link
Copy Markdown
Contributor

Remove conflicts as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants