[Docs] Minor fixes in EN docs to remove or replace unicode chars with ascii #1018
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
While attempting to
sphinx-build
alatexpdf
of the EN docs on latest master, I encountered several build failures due to the usage of various non-ascii chars.For example:
:
vs:
()
vs()
,
vs,
zh_cn
comments in documented code-blocksThe 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