Skip to content

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

sharanramjee
Copy link
Contributor

Description

Updated docstrings and fixed old pylint errors in core/download files.

@googlebot googlebot added the cla: yes Author has signed CLA label Jul 4, 2020
@sharanramjee sharanramjee added the documentation Pull Request or Issue related with comments or documentation label Jul 4, 2020
@tfds-bot tfds-bot added the community:please_review Community - We need your help to review this PR. label Jul 4, 2020
Copy link
Member

@Conchylicultor Conchylicultor left a 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.

@tfds-bot tfds-bot added author:please_respond Author - please respond to the recent comments. and removed community:please_review Community - We need your help to review this PR. labels Jul 6, 2020
@tfds-bot tfds-bot added tfds:is_reviewing TFDS team: PTAL author:please_respond Author - please respond to the recent comments. and removed author:please_respond Author - please respond to the recent comments. tfds:is_reviewing TFDS team: PTAL labels Jul 6, 2020
@sharanramjee sharanramjee added tfds:please_review TFDS team: please review this PR. and removed author:please_respond Author - please respond to the recent comments. labels Jul 11, 2020
@tfds-bot tfds-bot added author:please_respond Author - please respond to the recent comments. and removed tfds:please_review TFDS team: please review this PR. labels Jul 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author:please_respond Author - please respond to the recent comments. cla: yes Author has signed CLA documentation Pull Request or Issue related with comments or documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants