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] Minor fixes in EN docs to remove or replace unicode chars with ascii #1018

Merged

Conversation

evdcush
Copy link
Contributor

@evdcush evdcush commented Mar 26, 2023

Motivation

While attempting to sphinx-build a latexpdf of the EN docs on latest master, I encountered several build failures due to the usage of various non-ascii chars.

For example:

  • 'Full-width' punctuation chars instead of normal ascii:
    • vs :
    • () vs ()
    • vs ,
    • etc..
  • Various zh_cn comments in documented code-blocks

The use of "full-width" chars (also referred to as 'double-byte' in JIS encoding) can cause issues with certain Sphinx build target formats (such as latexpdf).

They can also cause various other issues for users, especially users who can only reference EN documentation, who may not have a device with Asian language support.

As such, to allow for smoother docs builds and for usability/readability for EN-based users, our EN docs should be constrained to the ASCII charset as much as possible.

Modification

Remove zh_cn comments from EN docs:

  • docs/en/migration/runner.md
  • docs/en/tutorials/model.md

Replace 'full-width' punctuation chars with ascii:

  • docs/en/advanced_tutorials/basedataset.md
  • docs/en/advanced_tutorials/config.md
  • docs/en/advanced_tutorials/initialize.md
  • docs/en/advanced_tutorials/test_time_augmentation.md
  • docs/en/tutorials/optim_wrapper.md
  • docs/en/tutorials/param_scheduler.md

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. ✅

…cii chars

* Remove CN comments in EN docs code
* Replace some full-width unicode chars with half-width ascii chars
@CLAassistant
Copy link

CLAassistant commented Mar 26, 2023

CLA assistant check
All committers have signed the CLA.

@evdcush evdcush marked this pull request as ready for review March 26, 2023 03:42
@evdcush evdcush requested a review from C1rN09 as a code owner March 26, 2023 03:42
@zhouzaida zhouzaida merged commit f356b3c into open-mmlab:main Mar 26, 2023
@evdcush evdcush deleted the evdcush/fix_some_non-ascii_chars_in_docs branch March 26, 2023 08:12
@OpenMMLab-Assistant-004

Hi @evdcush !First of all, we want to express our gratitude for your significant PR in the mmengine project. Your contribution is highly appreciated, and we are grateful for your efforts in helping improve this open-source project during your personal time. We believe that many developers will benefit from your PR.

We would also like to invite you to join our Special Interest Group (SIG) private channel on Discord, where you can share your experiences, ideas, and build connections with like-minded peers. To join the SIG channel, simply message moderator— OpenMMLab on Discord or briefly share your open-source contributions in the #introductions channel and we will assist you. Look forward to seeing you there! Join us :https://discord.gg/raweFPmdzG

If you have WeChat,welcome to join our community on WeChat. You can add our assistant :openmmlabwx. Please add "mmsig + Github ID" as a remark when adding friends:)
Thank you again for your contribution❤

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