-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Update core/download docstrings #2149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Update core/download docstrings #2149
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for trying to make our code to looks better.
However, my feeling is that we shouldn't spend too much time on those cosmetic changes when there are much more important / impactful tasks to do.
For instance, changing:
def asdict(self) -> Dict[str, Any]:
"""Returns the dict representation of the dataclass."""
To:
def asdict(self) -> Dict[str, Any]:
"""Returns the dict representation of the dataclass.
Returns:
Dict representation of the dataclass.
"""
Doesn't add really any value (neither for the developer, nor for the final user).
When you have a limited number of time, you should try focussing on things which really matter. For instance adding new features. It would also be much more interesting for you.
Description
Updated docstrings and fixed old pylint errors in core/download files.