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

revise eng docs #8868

Merged
merged 1 commit into from
Sep 26, 2022
Merged

revise eng docs #8868

merged 1 commit into from
Sep 26, 2022

Conversation

xin-li-67
Copy link
Contributor

Motivation

Updated a little bit on some documents.

Modification

modified: README.md
modified: README_zh-CN.md
modified: docs/en/get_started.md
modified: docs/en/user_guides/config.md
modified: docs/en/user_guides/dataset_prepare.md
modified: docs/zh_cn/get_started.md

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
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

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@CLAassistant
Copy link

CLAassistant commented Sep 23, 2022

CLA assistant check
All committers have signed the CLA.

@ZwwWayne ZwwWayne added this to the 3.0.0rc2 milestone Sep 26, 2022
@ZwwWayne ZwwWayne merged commit a5bda9a into open-mmlab:3.x Sep 26, 2022
@xin-li-67 xin-li-67 deleted the 3.x-eng-doc branch September 26, 2022 06:39
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.

4 participants