You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
msgid "If you are not familiar with reStructuredText (RST) syntax, please read `this guide`_ before translating on Weblate."
130
130
msgstr ""
131
131
132
-
#: ../source/contribute.rst:105
132
+
#: ../source/contribute.rst:118
133
133
msgid "**Do not translate the text in reference directly**"
134
134
msgstr ""
135
135
136
-
#: ../source/contribute.rst:107
136
+
#: ../source/contribute.rst:106
137
137
msgid "When translating the text in reference, please do not translate them directly."
138
138
msgstr ""
139
139
@@ -145,119 +145,119 @@ msgstr ""
145
145
msgid "Right: Translate the following text with your own language and add the original reference:"
146
146
msgstr ""
147
147
148
-
#: ../source/contribute.rst:124
148
+
#: ../source/contribute.rst:123
149
149
msgid "Building the guide locally"
150
150
msgstr ""
151
151
152
-
#: ../source/contribute.rst:126
152
+
#: ../source/contribute.rst:125
153
153
msgid "Though not required to contribute, it may be useful to build this guide locally in order to test your changes. In order to build this guide locally, you'll need:"
154
154
msgstr ""
155
155
156
-
#: ../source/contribute.rst:130
156
+
#: ../source/contribute.rst:129
157
157
msgid ":doc:`Nox <nox:index>`. You can install or upgrade nox using ``pip``:"
158
158
msgstr ""
159
159
160
-
#: ../source/contribute.rst:137
160
+
#: ../source/contribute.rst:136
161
161
msgid "Python 3.11. Our build scripts are usually tested with Python 3.11 only. See the :doc:`Hitchhiker's Guide to Python installation instructions <python-guide:starting/installation>` to install Python 3.11 on your operating system."
162
162
msgstr ""
163
163
164
-
#: ../source/contribute.rst:141
164
+
#: ../source/contribute.rst:140
165
165
msgid "To build the guide, run the following shell command in the project's root folder:"
166
166
msgstr ""
167
167
168
-
#: ../source/contribute.rst:147
168
+
#: ../source/contribute.rst:146
169
169
msgid "After the process has completed you can find the HTML output in the ``./build/html`` directory. You can open the ``index.html`` file to view the guide in web browser, but it's recommended to serve the guide using an HTTP server."
170
170
msgstr ""
171
171
172
-
#: ../source/contribute.rst:152
172
+
#: ../source/contribute.rst:151
173
173
msgid "You can build the guide and serve it via an HTTP server using the following command:"
174
174
msgstr ""
175
175
176
-
#: ../source/contribute.rst:159
176
+
#: ../source/contribute.rst:158
177
177
msgid "The guide will be browsable via http://localhost:8000."
178
178
msgstr ""
179
179
180
-
#: ../source/contribute.rst:163
180
+
#: ../source/contribute.rst:162
181
181
msgid "Where the guide is deployed"
182
182
msgstr ""
183
183
184
-
#: ../source/contribute.rst:165
184
+
#: ../source/contribute.rst:164
185
185
msgid "The guide is deployed via ReadTheDocs and the configuration lives at https://readthedocs.org/projects/python-packaging-user-guide/. It's served from a custom domain and fronted by Fast.ly."
186
186
msgstr ""
187
187
188
-
#: ../source/contribute.rst:171
188
+
#: ../source/contribute.rst:170
189
189
msgid "Style guide"
190
190
msgstr ""
191
191
192
-
#: ../source/contribute.rst:173
192
+
#: ../source/contribute.rst:172
193
193
msgid "This style guide has recommendations for how you should write the |PyPUG|. Before you start writing, please review it. By following the style guide, your contributions will help add to a cohesive whole and make it easier for your contributions to be accepted into the project."
194
194
msgstr ""
195
195
196
-
#: ../source/contribute.rst:180
196
+
#: ../source/contribute.rst:179
197
197
msgid "Purpose"
198
198
msgstr ""
199
199
200
-
#: ../source/contribute.rst:182
200
+
#: ../source/contribute.rst:181
201
201
msgid "The purpose of the |PyPUG| is to be the authoritative resource on how to package, publish, and install Python projects using current tools."
202
202
msgstr ""
203
203
204
-
#: ../source/contribute.rst:187
204
+
#: ../source/contribute.rst:186
205
205
msgid "Scope"
206
206
msgstr ""
207
207
208
-
#: ../source/contribute.rst:189
208
+
#: ../source/contribute.rst:188
209
209
msgid "The guide is meant to answer questions and solve problems with accurate and focused recommendations."
210
210
msgstr ""
211
211
212
-
#: ../source/contribute.rst:192
212
+
#: ../source/contribute.rst:191
213
213
msgid "The guide isn't meant to be comprehensive and it's not meant to replace individual projects' documentation. For example, pip has dozens of commands, options, and settings. The pip documentation describes each of them in detail, while this guide describes only the parts of pip that are needed to complete the specific tasks described in this guide."
214
214
msgstr ""
215
215
216
-
#: ../source/contribute.rst:200
216
+
#: ../source/contribute.rst:199
217
217
msgid "Audience"
218
218
msgstr ""
219
219
220
-
#: ../source/contribute.rst:202
220
+
#: ../source/contribute.rst:201
221
221
msgid "The audience of this guide is anyone who uses Python with packages."
222
222
msgstr ""
223
223
224
-
#: ../source/contribute.rst:204
224
+
#: ../source/contribute.rst:203
225
225
msgid "Don't forget that the Python community is big and welcoming. Readers may not share your age, gender, education, culture, and more, but they deserve to learn about packaging just as much as you do."
226
226
msgstr ""
227
227
228
-
#: ../source/contribute.rst:208
228
+
#: ../source/contribute.rst:207
229
229
msgid "In particular, keep in mind that not all people who use Python see themselves as programmers. The audience of this guide includes astronomers or painters or students as well as professional software developers."
230
230
msgstr ""
231
231
232
-
#: ../source/contribute.rst:214
232
+
#: ../source/contribute.rst:213
233
233
msgid "Voice and tone"
234
234
msgstr ""
235
235
236
-
#: ../source/contribute.rst:216
236
+
#: ../source/contribute.rst:215
237
237
msgid "When writing this guide, strive to write with a voice that's approachable and humble, even if you have all the answers."
238
238
msgstr ""
239
239
240
-
#: ../source/contribute.rst:219
240
+
#: ../source/contribute.rst:218
241
241
msgid "Imagine you're working on a Python project with someone you know to be smart and skilled. You like working with them and they like working with you. That person has asked you a question and you know the answer. How do you respond? *That* is how you should write this guide."
242
242
msgstr ""
243
243
244
-
#: ../source/contribute.rst:224
244
+
#: ../source/contribute.rst:223
245
245
msgid "Here's a quick check: try reading aloud to get a sense for your writing's voice and tone. Does it sound like something you would say or does it sound like you're acting out a part or giving a speech? Feel free to use contractions and don't worry about sticking to fussy grammar rules. You are hereby granted permission to end a sentence in a preposition, if that's what you want to end it with."
246
246
msgstr ""
247
247
248
-
#: ../source/contribute.rst:231
248
+
#: ../source/contribute.rst:230
249
249
msgid "When writing the guide, adjust your tone for the seriousness and difficulty of the topic. If you're writing an introductory tutorial, it's OK to make a joke, but if you're covering a sensitive security recommendation, you might want to avoid jokes altogether."
250
250
msgstr ""
251
251
252
-
#: ../source/contribute.rst:238
252
+
#: ../source/contribute.rst:237
253
253
msgid "Conventions and mechanics"
254
254
msgstr ""
255
255
256
-
#: ../source/contribute.rst:246
256
+
#: ../source/contribute.rst:245
257
257
msgid "**Write to the reader**"
258
258
msgstr ""
259
259
260
-
#: ../source/contribute.rst:241
260
+
#: ../source/contribute.rst:240
261
261
msgid "When giving recommendations or steps to take, address the reader as *you* or use the imperative mood."
262
262
msgstr ""
263
263
@@ -273,27 +273,27 @@ msgstr ""
273
273
msgid "Right: To install it, run…"
274
274
msgstr ""
275
275
276
-
#: ../source/contribute.rst:252
276
+
#: ../source/contribute.rst:251
277
277
msgid "**State assumptions**"
278
278
msgstr ""
279
279
280
-
#: ../source/contribute.rst:249
280
+
#: ../source/contribute.rst:248
281
281
msgid "Avoid making unstated assumptions. Reading on the web means that any page of the guide may be the first page of the guide that the reader ever sees. If you're going to make assumptions, then say what assumptions that you're going to make."
282
282
msgstr ""
283
283
284
-
#: ../source/contribute.rst:257
284
+
#: ../source/contribute.rst:256
285
285
msgid "**Cross-reference generously**"
286
286
msgstr ""
287
287
288
-
#: ../source/contribute.rst:255
288
+
#: ../source/contribute.rst:254
289
289
msgid "The first time you mention a tool or practice, link to the part of the guide that covers it, or link to a relevant document elsewhere. Save the reader a search."
290
290
msgstr ""
291
291
292
-
#: ../source/contribute.rst:267
292
+
#: ../source/contribute.rst:266
293
293
msgid "**Respect naming practices**"
294
294
msgstr ""
295
295
296
-
#: ../source/contribute.rst:260
296
+
#: ../source/contribute.rst:259
297
297
msgid "When naming tools, sites, people, and other proper nouns, use their preferred capitalization."
298
298
msgstr ""
299
299
@@ -313,11 +313,11 @@ msgstr ""
313
313
msgid "Right: …hosted on GitHub."
314
314
msgstr ""
315
315
316
-
#: ../source/contribute.rst:276
316
+
#: ../source/contribute.rst:275
317
317
msgid "**Use a gender-neutral style**"
318
318
msgstr ""
319
319
320
-
#: ../source/contribute.rst:270
320
+
#: ../source/contribute.rst:269
321
321
msgid "Often, you'll address the reader directly with *you*, *your* and *yours*. Otherwise, use gender-neutral pronouns *they*, *their*, and *theirs* or avoid pronouns entirely."
322
322
msgstr ""
323
323
@@ -333,15 +333,15 @@ msgstr ""
333
333
msgid "Right: A maintainer uploads the file. Then the maintainer…"
334
334
msgstr ""
335
335
336
-
#: ../source/contribute.rst:288
336
+
#: ../source/contribute.rst:287
337
337
msgid "**Headings**"
338
338
msgstr ""
339
339
340
-
#: ../source/contribute.rst:279
340
+
#: ../source/contribute.rst:278
341
341
msgid "Write headings that use words the reader is searching for. A good way to do this is to have your heading complete an implied question. For example, a reader might want to know *How do I install MyLibrary?* so a good heading might be *Install MyLibrary*."
342
342
msgstr ""
343
343
344
-
#: ../source/contribute.rst:284
344
+
#: ../source/contribute.rst:283
345
345
msgid "In section headings, use sentence case. In other words, write headings as you would write a typical sentence."
346
346
msgstr ""
347
347
@@ -353,11 +353,11 @@ msgstr ""
353
353
msgid "Right: Things you should know about Python"
354
354
msgstr ""
355
355
356
-
#: ../source/contribute.rst:291
356
+
#: ../source/contribute.rst:290
357
357
msgid "**Numbers**"
358
358
msgstr ""
359
359
360
-
#: ../source/contribute.rst:291
360
+
#: ../source/contribute.rst:290
361
361
msgid "In body text, write numbers one through nine as words. For other numbers or numbers in tables, use numerals."
0 commit comments