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

Fix typos and remove fullwidth unicode chars #1488

Conversation

evdcush
Copy link
Contributor

@evdcush evdcush commented Feb 7, 2024

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. By the way, if you're not familiar with how to use pre-commit to fix lint issues or add unit tests, please refer to Contributing to OpenMMLab.

Motivation

There are "fullwidth" unicode characters (mostly punctuation symbols) used in various places in MMEngine's documentation. These characters should not be used in EN documentation, as they are not generally supported by various documentation builds, such as latexpdf, and can cause issues with static analysis tools.

There are also various fixes to typos included in this branch, including some to paths in source code.

Related to #1018

Modification

  • Replace fullwidth unicode chars with ascii equivalents
  • Fix typos
    • Fix module name and import these have been reverted to avoid BC

BC-breaking (Optional)

N/A

Use cases (Optional)

N/A

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 MMDetection or MMPretrain.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@evdcush evdcush marked this pull request as ready for review February 7, 2024 22:02
@evdcush evdcush changed the title Fix/evdcush/correct src typos and remove fullwidth chars Fix typos and remove fullwidth unicode chars Feb 7, 2024
@evdcush
Copy link
Contributor Author

evdcush commented Feb 10, 2024

These test failures appear unrelated to my diffs 👇🏻

screencap_2024-02-10_20-19-34

@evdcush
Copy link
Contributor Author

evdcush commented Feb 15, 2024

@Harold-lkk @HAOCHENYE @C1rN09 @zhouzaida

May I receive a review please?

@zhouzaida
Copy link
Member

Hi @evdcush , thanks for your contribution. Last week we were on vacation and I am reviewing this PR now.

@evdcush
Copy link
Contributor Author

evdcush commented Feb 18, 2024

Hi @zhouzaida, thank you for your review! 🙇🏻‍♂️

I have undone the diffs you mentioned as potential BC.

@zhouzaida zhouzaida merged commit 4df682b into open-mmlab:main Feb 18, 2024
16 of 20 checks passed
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

2 participants