tutorials icon indicating copy to clipboard operation
tutorials copied to clipboard

💡 [REQUEST] - Remove unnecessary backticks

Open 9bow opened this issue 2 years ago • 3 comments

🚀 Descirbe the improvement or the new tutorial

Hi, @svekars.

I'm translating & maintaining the PyTorch tutorials into Korean and incorporating the changes (as the new version is released).

First of all, I want to thank you for the many backticks(`) and spelling improvements that came with the move to 2.0. However, some articles seem to have added unnecessary backticks and should probably be removed.

For example, on line 78 of thee advanced_source/numpy_extensions_tutorial.py, the backtick seems unnecessary because wrt is short for with respect to.

I've summarized the four issues I found in the three documents below.

I've also found a few cases where the opposite is true - where a backtick appears to be required but isn't, but I'll raise that as a separate issue.

If you think this is a meaningful change, let me know. I'll create a pull request.

Existing tutorials on this topic

  • wrt on https://github.com/pytorch/tutorials/blob/main/advanced_source/numpy_extensions_tutorial.py#L78
  • SuperResoltion on https://github.com/pytorch/tutorials/blob/main/advanced_source/super_resolution_with_onnxruntime.py#L40
  • YCbCr on https://github.com/pytorch/tutorials/blob/main/advanced_source/super_resolution_with_onnxruntime.py#LL45C46-L45C51
  • prev on https://github.com/pytorch/tutorials/blob/main/intermediate_source/model_parallel_tutorial.py#LL342C43-L342C43

Additional context

No response

cc @svekars @carljparker

9bow avatar May 06 '23 05:05 9bow

Thanks for the feedbak @9bow and I appreciate that you brought this issue to my attention. We have incorporated a spellcheck in the tutorials repo. The backticks were added to the words that refer to methods, variables, functions, and other entities that represent or related to coding symbols. The spellcheck fails on the word wrt because it's not a proper word in the English language, so yes, it should be changed to with respect to. Agree on the SuperResolution - should be changed to Super-Resolution and added to the en-wordlist. Same with YCbCr - add to the dictionary. I'm really not sure about prev as the word prev is not a real word what do you think?

svekars avatar May 08 '23 15:05 svekars

Thanks, @svekars, Now I understand how the backticks were added. So for prev, I think we just modify it previous like wrt, but I'll have to think about SuperResolution a bit more. Actually, SuperResolution is probably more ambiguous case, because it's often used as the name of a model class - maybe this time it's better to change SuperResolution to SuperResolutionNet as it refers class name below context. If I come up with something, I'll add it back.

9bow avatar May 09 '23 02:05 9bow

Do you have any additional comment about this, @svekars ? If not, may I make a PR as I described as above comment?

9bow avatar May 11 '23 09:05 9bow