Skip to content

Commit 4018ac5

Browse files
update readme
1 parent 06f9c4b commit 4018ac5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,16 @@ GALLERY_PATTERN="neural_style_transfer_tutorial.py" sphinx-build . _build
5757

5858
The `GALLERY_PATTERN` variable respects regular expressions.
5959

60+
## Spelling Check
61+
You can run pyspelling to check for spelling errors in the tutorials. To check only Python files, run pyspelling -n python (takes about 3 minutes). To check only .rst files, use pyspelling -n reST. Currently, .rst spell checking is limited to the beginner/ directory. Contributions to enable spell checking in other directories are welcome!
62+
63+
64+
```
65+
pyspelling # full check (~3 mins)
66+
pyspelling -n python # Python files only
67+
pyspelling -n reST # reST files (only beginner/ dir currently included)
68+
```
69+
6070

6171
## About contributing to PyTorch Documentation and Tutorials
6272
* You can find information about contributing to PyTorch documentation in the

0 commit comments

Comments
 (0)