Skip to content
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

docs(opendataset): update module docstring for opendataset #1115

Merged

Conversation

wangyuqing0424
Copy link
Collaborator

@wangyuqing0424 wangyuqing0424 commented Nov 22, 2021

No description provided.

@coveralls
Copy link

coveralls commented Nov 22, 2021

Pull Request Test Coverage Report for Build 1493734003

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 86.582%

Totals Coverage Status
Change from base Build 1493239823: 0.0%
Covered Lines: 7614
Relevant Lines: 8794

💛 - Coveralls

@@ -4,6 +4,7 @@
#
# pylint: disable=invalid-name
# pylint: disable=missing-module-docstring
"""Dataloader of AnimalPose5 dataset and AnimalPose7 dataset."""
Copy link
Contributor

Choose a reason for hiding this comment

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

Dataloaders, other docstrings are also need to change

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

whether there are more than two datasets I need to change to the dataloaders or I have to change all the dataloader to loaders

Copy link
Contributor

Choose a reason for hiding this comment

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

use "Dataloaders" when there are two datasets

@@ -3,6 +3,7 @@
# Copyright 2021 Graviti. Licensed under MIT License.
#
# pylint: disable=invalid-name, missing-module-docstring
Copy link
Contributor

Choose a reason for hiding this comment

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

the missing-module-docstring comment can be removed

@wangyuqing0424 wangyuqing0424 changed the title docs(opendataset): update module docstring of data loaders docs(opendataset): update module docstring and remove missing-module-docstring comment Nov 22, 2021
@wangyuqing0424 wangyuqing0424 requested review from graczhual and linjiX and removed request for Lee-000 November 22, 2021 08:10
@@ -435,14 +435,17 @@ def _loads(self, contents: Dict[str, Any]) -> None:
self.committer = User.loads(contents["committer"])


class Draft(AttrsMixin, ReprMixin):
class Draft(AttrsMixin, ReprMixin): # pylint: disable=too-many-instance-attributes
Copy link
Contributor

Choose a reason for hiding this comment

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

your PR includes commits from other friends, it need to be fixed.

@@ -2,7 +2,8 @@
#
Copy link
Contributor

Choose a reason for hiding this comment

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

commit message is too long
update module docstring for opendataset is enough

@wangyuqing0424 wangyuqing0424 force-pushed the T19847_docstring_update branch 2 times, most recently from 7c8c56f to f25d642 Compare November 23, 2021 02:38
@wangyuqing0424 wangyuqing0424 changed the title docs(opendataset): update module docstring and remove missing-module-docstring comment docs(opendataset): update module docstring Nov 23, 2021
@@ -1,8 +1,9 @@
#!/usr/bin/env python3
#
# Copyright 2021 Graviti. Licensed under MIT License.
#
# pylint: disable=invalid-name, missing-module-docstring

Copy link
Contributor

Choose a reason for hiding this comment

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

do not need to delete #

@wangyuqing0424 wangyuqing0424 changed the title docs(opendataset): update module docstring docs(opendataset): update module docstring for opendataset Nov 23, 2021
@wangyuqing0424 wangyuqing0424 merged commit 766371f into Graviti-AI:main Nov 23, 2021
@wangyuqing0424 wangyuqing0424 deleted the T19847_docstring_update branch November 23, 2021 07:38
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.

None yet

4 participants