Skip to content

Commit bb5f00e

Browse files
committed
Remove trailing whitespaces
Slightly rephrase phrase about downloads
1 parent 2a6b9e9 commit bb5f00e

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ There are three types of tutorial content that we host on
6565
code in these tutorials is run every time they are built. To keep
6666
these tutorials up and running all their package dependencies need to
6767
be resolved--which makes it more challenging to maintain this type of
68-
tutorial.
68+
tutorial.
6969

7070
* **Non-interactive tutorials** are authored and submitted as
7171
reStructuredText files. The build system only converts them into HTML;
@@ -80,17 +80,16 @@ There are three types of tutorial content that we host on
8080
non-interactive.
8181

8282

83-
# Managing data that is used by your tutorial
83+
# Managing data that is used by your tutorial
8484

8585
Your tutorial might depend on external data, such as pre-trained models,
8686
training data, or test data. We recommend storing this data in a
8787
commonly-used storage service, such as Amazon S3, and instructing your
88-
users to download the data at the beginning of your tutorial.
88+
users to download the data at the beginning of your tutorial.
8989

9090
To download your data add a function to the [download.py](https://github.com/pytorch/tutorials/blob/main/.jenkins/download_data.py)
9191
script. Follow the same pattern as other download functions.
92-
Please do not add download logic to Makefile since they will be
93-
downloaded on all workers.
92+
Please do not add download logic to `Makefile` as it will incur download overhead for all CI shards.
9493

9594
# Python packages used by your tutorial
9695

@@ -103,7 +102,7 @@ tutorial fails to build in our Continuous Integration (CI) system, we
103102
might contact you in order to resolve the issue.
104103

105104

106-
# Deprecation of tutorials
105+
# Deprecation of tutorials
107106

108107
Under some circumstances, we might deprecate--and subsequently
109108
archive--a tutorial removing it from the site. For example, if the
@@ -136,7 +135,7 @@ end-to-end understanding of how to use PyTorch. Recipes are scoped
136135
examples of how to use specific features; the goal of a recipe is to
137136
teach readers how to easily leverage features of PyTorch for their
138137
needs. Tutorials and recipes are always _actionable_. If the material is
139-
purely informative, consider adding it to the API docs instead.
138+
purely informative, consider adding it to the API docs instead.
140139

141140
View our current [full-length tutorials](https://pytorch.org/tutorials/).
142141

@@ -164,11 +163,11 @@ Write for a global audience with an instructive and directive voice.
164163
- PyTorch has a global audience; use clear, easy to understand
165164
language. Avoid idioms or other figures of speech.
166165
- To keep your instructions concise, use
167-
[active voice](https://writing.wisc.edu/handbook/style/ccs_activevoice/) as much as possible.
168-
- For a short guide on the essentials of writing style,
166+
[active voice](https://writing.wisc.edu/handbook/style/ccs_activevoice/) as much as possible.
167+
- For a short guide on the essentials of writing style,
169168
[The Elements of Style](https://www.gutenberg.org/files/37134/37134-h/37134-h.htm)
170169
is invaluable.
171-
- For extensive guidance on technical-writing style, the Google developer documentation
170+
- For extensive guidance on technical-writing style, the Google developer documentation
172171
[google style](https://developers.google.com/style)
173172
is a great resource.
174173
- Think of the process as similar to creating a (really practical)
@@ -194,7 +193,7 @@ We recommend that tutorials use the following structure which guides users throu
194193
1. Step-by-step instructions. Ideally, the steps in the tutorial should
195194
map back to the learning objectives. Consider adding comments in the
196195
code that correspond to these steps and that help to clarify what
197-
each section of the code is doing.
196+
each section of the code is doing.
198197
1. Link to relevant [PyTorch
199198
documentation](https://pytorch.org/docs/stable/index.html). This
200199
helps readers have context for the tutorial source code and better
@@ -229,7 +228,7 @@ as a guide.
229228
Submit your tutorial as either a Python (`.py`) file or a
230229
reStructuredText (`.rst`) file. For Python files, the filename for your
231230
tutorial should end in "`_tutorial.py`"; for example,
232-
"`cool_pytorch_feature_tutorial.py`".
231+
"`cool_pytorch_feature_tutorial.py`".
233232

234233
Do not submit a Jupyter notebook. If you develop your tutorial in
235234
Jupyter, you'll need to convert it to Python. This
@@ -275,8 +274,8 @@ search, you need to include it in `index.rst`, or for recipes, in
275274
:header: Learn the Basics # Tutorial title
276275
:card_description: A step-by-step guide to building a complete ML workflow with PyTorch. # Short description
277276
:image: _static/img/thumbnails/cropped/60-min-blitz.png # Image that appears with the card
278-
:link: beginner/basics/intro.html
279-
:tags: Getting-Started
277+
:link: beginner/basics/intro.html
278+
:tags: Getting-Started
280279
```
281280

282281

@@ -339,7 +338,7 @@ test your tutorial when you submit your PR.
339338

340339

341340
## Submit the PR ##
342-
341+
343342
NOTE: Please do not use [ghstack](https://github.com/ezyang/ghstack). We
344343
do not support ghstack in the [`pytorch/tutorials`](https://github.com/pytorch/tutorials) repo.
345344

@@ -367,5 +366,5 @@ build. You can see an example Netlify preview at the following URL:
367366
368367
## Do not merge the PR yourself ##
369368
370-
Please **DO NOT MERGE** your own PR; the tutorial won't be published. In order to avoid potential build breaks with the tutorials site, only certain maintainers can authorize publishing.
369+
Please **DO NOT MERGE** your own PR; the tutorial won't be published. In order to avoid potential build breaks with the tutorials site, only certain maintainers can authorize publishing.
371370

0 commit comments

Comments
 (0)