Skip to content

Update ops docstring#2

Merged
zhouzaida merged 2 commits intofix-ops-docstringfrom
update-ops-docstring
Dec 7, 2021
Merged

Update ops docstring#2
zhouzaida merged 2 commits intofix-ops-docstringfrom
update-ops-docstring

Conversation

@zhouzaida
Copy link
Copy Markdown
Owner

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

@zhouzaida zhouzaida merged commit e7c93e7 into fix-ops-docstring Dec 7, 2021
@zhouzaida zhouzaida deleted the update-ops-docstring branch December 7, 2021 12:20
zhouzaida added a commit that referenced this pull request Dec 9, 2021
* [Docs] Fix the format of return

* replace List with list

* format the documentation of optimizer

* Update ops docstring (#2)

* update ops docstring

* fix typos

Co-authored-by: ChaimZhu <zhuchenming@pjlab.org.cn>

Co-authored-by: ChaimZhu <zhuchenming@pjlab.org.cn>
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