Skip to content

Commit 35874b4

Browse files
committed
Use ## for glossary sections and link STYLE_GUIDE.md
1 parent eec601b commit 35874b4

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

‎GLOSSARY.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Punjabi (pa) Python Docs Glossary
22

3-
These are the Punjabi terms we use when translating the Python documentation, so that the translation stays consistent. For how we write, see `STYLE_GUIDE.md`.
3+
These are the Punjabi terms we use when translating the Python documentation, so that the translation stays consistent. For how we write, see [STYLE_GUIDE.md](STYLE_GUIDE.md).
44

5-
# How to Use This Glossary
5+
## How to Use This Glossary
66

77
- If a term is listed here, use it. Don't use a variant.
8-
- If it isn't listed, reuse the wording from existing translations. If there is none, follow the steps under "Technical terms" in `STYLE_GUIDE.md` and propose the term as described under "Adding or Changing a Term" below.
8+
- If it isn't listed, reuse the wording from existing translations. If there is none, follow the steps under "Technical terms" in [STYLE_GUIDE.md](STYLE_GUIDE.md) and propose the term as described under "Adding or Changing a Term" below.
99
- Never translate function, module, class and exception names, directives, roles, placeholders or code.
1010

1111
---
1212

13-
# Core Python Terms
13+
## Core Python Terms
1414

1515
| English | Preferred Punjabi |
1616
|---------|-------------------|
@@ -50,7 +50,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
5050

5151
---
5252

53-
# Data Types
53+
## Data Types
5454

5555
| English | Preferred Punjabi |
5656
|---------|-------------------|
@@ -83,7 +83,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
8383

8484
---
8585

86-
# Mutability
86+
## Mutability
8787

8888
| English | Preferred Punjabi |
8989
|---------|-------------------|
@@ -94,7 +94,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
9494

9595
---
9696

97-
# Operators and Operations
97+
## Operators and Operations
9898

9999
| English | Preferred Punjabi |
100100
|---------|-------------------|
@@ -114,7 +114,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
114114

115115
---
116116

117-
# Collections and Iteration
117+
## Collections and Iteration
118118

119119
| English | Preferred Punjabi |
120120
|---------|-------------------|
@@ -125,7 +125,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
125125

126126
---
127127

128-
# Exceptions and Errors
128+
## Exceptions and Errors
129129

130130
| English | Preferred Punjabi |
131131
|---------|-------------------|
@@ -137,7 +137,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
137137

138138
---
139139

140-
# Modules and Libraries
140+
## Modules and Libraries
141141

142142
| English | Preferred Punjabi |
143143
|---------|-------------------|
@@ -152,7 +152,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
152152

153153
---
154154

155-
# String and Formatting Terms
155+
## String and Formatting Terms
156156

157157
| English | Preferred Punjabi |
158158
|---------|-------------------|
@@ -172,7 +172,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
172172

173173
---
174174

175-
# Numeric Terms
175+
## Numeric Terms
176176

177177
| English | Preferred Punjabi |
178178
|---------|-------------------|
@@ -191,7 +191,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
191191

192192
---
193193

194-
# Standard Library Terms
194+
## Standard Library Terms
195195

196196
| English | Preferred Punjabi |
197197
|---------|-------------------|
@@ -213,7 +213,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
213213

214214
---
215215

216-
# Documentation Terms
216+
## Documentation Terms
217217

218218
| English | Preferred Punjabi |
219219
|---------|-------------------|
@@ -234,7 +234,7 @@ These are the Punjabi terms we use when translating the Python documentation, so
234234

235235
---
236236

237-
# Documentation Workflow Terms
237+
## Documentation Workflow Terms
238238

239239
| English | Preferred Punjabi |
240240
|---------|-------------------|
@@ -255,19 +255,19 @@ These are the Punjabi terms we use when translating the Python documentation, so
255255

256256
---
257257

258-
# Terms Commonly Left Untranslated
258+
## Terms Commonly Left Untranslated
259259

260260
These widely used terms normally stay in English: Python, API, JSON, XML, HTML, HTTP, HTTPS, URL, Unicode, UTF-8, ASCII, Git, GitHub, Transifex, Linux, Windows, macOS, POSIX, CPython, PyPI, pip, venv, IDLE, REPL.
261261

262262
---
263263

264-
# Python Keywords
264+
## Python Keywords
265265

266266
Python keywords (`if`, `else`, `for`, `class`, `def`, `async`, `await`, `match` and so on) are never translated.
267267

268268
---
269269

270-
# Adding or Changing a Term
270+
## Adding or Changing a Term
271271

272272
1. Check that the term is not already listed under a different translation.
273273
2. Agree on the wording with the other contributors in the pull request or an issue, and check it against existing translations.

0 commit comments

Comments
 (0)