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] Update docs/zh_cn/tutorials/customize_config.md #23

Merged
merged 9 commits into from
Mar 2, 2022

Conversation

RangeKing
Copy link
Contributor

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

Help build Chinese Documentation.

Modification

  1. Update the zh_cn docs customize_config.md and get_started.md.
  2. Fix some typos and grammatical errors in en docs customize_config.md and get_started.md.

BC-breaking (Optional)

Does the modification introduce changes that break the back-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. The documentation has been modified accordingly, like docstring or example tutorials.

1. translate `get_started.md` into Chinese
2. fix some typos in `en/get_started.md`
3. fix a broken link in `en/get_started.md`
add missing blank space
1. translate `customize_config.md` into Chinese
2. fix some grammatical errors in `en/tutorials/customize_config.md`
@zytx121
Copy link
Collaborator

zytx121 commented Feb 23, 2022

Hi @RangeKing
get_started.md has been translated by others. #11
Please submit customize_config.md separately.

@RangeKing
Copy link
Contributor Author

RangeKing commented Feb 24, 2022

Hi @RangeKing get_started.md has been translated by others. #11 Please submit customize_config.md separately.

@zytx121 Already reverted get_started.md related commits.

@jbwang1997
Copy link
Collaborator

Thank you for your contributions. Please follow https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md to set pre-commit and fix the lint error.

@RangeKing RangeKing changed the title [Docs] Update docs/zh_cn/tutorials/customize_config.md and docs/zh_cn/get_started.md [Docs] Update docs/zh_cn/tutorials/customize_config.md Feb 24, 2022
@RangeKing
Copy link
Contributor Author

RangeKing commented Feb 24, 2022

Thank you for your contributions. Please follow https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md to set pre-commit and fix the lint error.

@jbwang1997 Already fixed the lint error.

Copy link
Collaborator

@jbwang1997 jbwang1997 left a comment

Choose a reason for hiding this comment

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

Look good to me. Kindly ping @zytx121 to have a look.

docs/zh_cn/tutorials/customize_config.md Outdated Show resolved Hide resolved
docs/zh_cn/tutorials/customize_config.md Outdated Show resolved Hide resolved
docs/zh_cn/tutorials/customize_config.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@zytx121 zytx121 left a comment

Choose a reason for hiding this comment

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

LGTM

@zytx121 zytx121 changed the base branch from main to dev March 1, 2022 07:29
@ZwwWayne
Copy link
Collaborator

ZwwWayne commented Mar 1, 2022

Hi @RangeKing ,
Thanks for your kind PR, could you help resolve the comments so that we can merge this PR?

Update code comments
@RangeKing
Copy link
Contributor Author

Hi @RangeKing , Thanks for your kind PR, could you help resolve the comments so that we can merge this PR?

Resolved.
I refer to these code comments from MMDetection Tutorial. Need to make the same changes to that tutorial?

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