|
1 | 1 | # Punjabi (pa) Python Docs Glossary |
2 | 2 |
|
3 | | -This glossary defines the preferred Punjabi terminology for translating the official Python documentation into Punjabi (`pa`). |
4 | | - |
5 | | -It complements `README.md`, `CONTRIBUTING.md`, and `STYLE_GUIDE.md` by providing standardized translations for technical terms used throughout the project. |
6 | | - |
7 | | -All contributors should use the terminology defined in this glossary to ensure consistency, technical accuracy, and long-term maintainability across all translated documentation. |
8 | | - |
9 | | ---- |
10 | | - |
11 | | -## Contents |
12 | | - |
13 | | -- [Project Status](#project-status) |
14 | | -- [How to Use This Glossary](#how-to-use-this-glossary) |
15 | | -- [Core Python Terms](#core-python-terms) |
16 | | -- [Data Types](#data-types) |
17 | | -- [Mutability](#mutability) |
18 | | -- [Operators and Operations](#operators-and-operations) |
19 | | -- [Collections and Iteration](#collections-and-iteration) |
20 | | -- [Exceptions and Errors](#exceptions-and-errors) |
21 | | -- [Modules and Libraries](#modules-and-libraries) |
22 | | -- [String and Formatting Terms](#string-and-formatting-terms) |
23 | | -- [Numeric Terms](#numeric-terms) |
24 | | -- [Standard Library Terms](#standard-library-terms) |
25 | | -- [Documentation Terms](#documentation-terms) |
26 | | -- [Documentation Workflow Terms](#documentation-workflow-terms) |
27 | | -- [Terms Commonly Left Untranslated](#terms-commonly-left-untranslated) |
28 | | -- [Common Python Keywords](#common-python-keywords) |
29 | | -- [Language Tag](#language-tag) |
30 | | -- [Consistency Rules](#consistency-rules) |
31 | | -- [Glossary Maintenance](#glossary-maintenance) |
32 | | -- [References](#references) |
33 | | -- [Final Notes](#final-notes) |
34 | | - |
35 | | ---- |
36 | | - |
37 | | -# Project Status |
38 | | - |
39 | | -The Punjabi (`pa`) translation project is actively maintained as part of the official Python Documentation Translation initiative. |
40 | | - |
41 | | -### Current Highlights |
42 | | - |
43 | | -- ✅ Officially listed in the Python Developer Guide Translation Coordinators (PR #1843) |
44 | | -- ✅ Active translation branch: `3.15` |
45 | | -- ✅ Automated synchronization with the official Python Documentation Transifex project |
46 | | -- ✅ GitHub Actions validation passing |
47 | | -- ✅ GNU gettext (`msgfmt`) validation passing |
48 | | -- ✅ `sphinx-lint` validation passing |
49 | | -- ✅ CPython HTML documentation build passing |
50 | | -- ✅ Nitpicky (`-n`) documentation build passing |
51 | | - |
52 | | -### Completed Translation Areas |
53 | | - |
54 | | -| Area | Status | |
55 | | -|------|--------| |
56 | | -| Tutorial Documentation (17/17 files) | ✅ Complete | |
57 | | -| Using Python Documentation (9/9 files) | ✅ Complete | |
58 | | -| `library/stdtypes.po` | ✅ Complete | |
59 | | -| `library/functions.po` | ✅ Complete | |
60 | | -| `library/exceptions.po` | ✅ Complete | |
61 | | -| `library/functools.po` | ✅ Complete | |
62 | | -| `library/string.po` | ✅ Complete | |
63 | | -| `howto/regex.po` | ✅ Complete | |
64 | | -| `howto/sorting.po` | ✅ Complete | |
65 | | -| `glossary.po` | ✅ Complete | |
66 | | -| `bugs.po` | ✅ Complete | |
67 | | - |
68 | | -### Translation Statistics |
69 | | - |
70 | | -| Metric | Value | |
71 | | -|--------|------:| |
72 | | -| Verified Translated Strings | **7,668** | |
73 | | -| Tutorial Files | 17 | |
74 | | -| Using Python Files | 9 | |
75 | | -| Completed Core Library Files | 5 | |
76 | | -| Completed HOWTO Files | 2 | |
77 | | -| Root Translation Files | 2 | |
78 | | - |
79 | | -The terminology defined in this glossary reflects the vocabulary established throughout the completed translations and should be treated as the project's preferred terminology for all future documentation. |
80 | | - |
81 | | ---- |
| 3 | +Preferred Punjabi terms for translating the Python documentation. Use them so translations stay consistent. For writing style, see `STYLE_GUIDE.md`. |
82 | 4 |
|
83 | 5 | # How to Use This Glossary |
84 | 6 |
|
85 | | -This glossary establishes the standard terminology for the Punjabi (`pa`) translation of the Python documentation. |
86 | | - |
87 | | -When translating documentation: |
88 | | - |
89 | | -- Always use glossary-approved terminology whenever a term already exists. |
90 | | -- Do not introduce alternative translations for established technical terms. |
91 | | -- Reuse terminology from previously completed translations whenever possible. |
92 | | -- Follow the writing conventions described in `STYLE_GUIDE.md`. |
93 | | -- Preserve technical accuracy while producing natural and readable Punjabi. |
94 | | - |
95 | | -If a required technical term is not yet included in this glossary: |
96 | | - |
97 | | -1. Check previously completed translation files for an established translation. |
98 | | -2. Use consistent terminology throughout the document. |
99 | | -3. Add the new term to this glossary only after it has been reviewed and adopted as the project's preferred translation. |
| 7 | +- Use the listed term whenever one exists. Do not introduce variants. |
| 8 | +- For a term that is not listed, reuse the wording from existing translations. If there is none, use one wording consistently in the file and propose it as described under "Adding or Changing a Term". |
| 9 | +- Never translate function, module, class and exception names, directives, roles, placeholders or code. |
100 | 10 |
|
101 | 11 | --- |
102 | 12 |
|
@@ -208,10 +118,7 @@ If a required technical term is not yet included in this glossary: |
208 | 118 |
|
209 | 119 | | English | Preferred Punjabi | |
210 | 120 | |---------|-------------------| |
211 | | -| iterable | ਇਟਰੇਬਲ | |
212 | | -| iterator | ਇਟਰੇਟਰ | |
213 | 121 | | loop | ਲੂਪ | |
214 | | -| iteration | ਇਟਰੇਸ਼ਨ | |
215 | 122 | | membership test | ਮੈਂਬਰਸ਼ਿਪ ਜਾਂਚ | |
216 | 123 | | sequence operations | ਕ੍ਰਮ ਕਾਰਵਾਈਆਂ | |
217 | 124 | | mapping operations | ਮੈਪਿੰਗ ਕਾਰਵਾਈਆਂ | |
@@ -277,7 +184,6 @@ If a required technical term is not yet included in this glossary: |
277 | 184 | | rounding | ਗੋਲਾਈਕਰਨ | |
278 | 185 | | conversion | ਰੂਪਾਂਤਰਨ | |
279 | 186 | | approximation | ਅਨੁਮਾਨ | |
280 | | -| floating-point | ਫਲੋਟਿੰਗ-ਪੌਇੰਟ | |
281 | 187 | | binary fraction | ਬਾਈਨਰੀ ਭਿੰਨ | |
282 | 188 | | decimal fraction | ਦਸ਼ਮਲਵ ਭਿੰਨ | |
283 | 189 | | representation | ਪ੍ਰਤਿਨਿਧਿਤਾ | |
@@ -351,145 +257,19 @@ If a required technical term is not yet included in this glossary: |
351 | 257 |
|
352 | 258 | # Terms Commonly Left Untranslated |
353 | 259 |
|
354 | | -The following terms are widely recognized within the Python ecosystem and should normally remain in English unless there is a strong project-wide reason to translate them. |
355 | | - |
356 | | -```text |
357 | | -Python |
358 | | -API |
359 | | -JSON |
360 | | -XML |
361 | | -HTML |
362 | | -HTTP |
363 | | -HTTPS |
364 | | -URL |
365 | | -Unicode |
366 | | -UTF-8 |
367 | | -ASCII |
368 | | -Git |
369 | | -GitHub |
370 | | -Transifex |
371 | | -Linux |
372 | | -Windows |
373 | | -macOS |
374 | | -POSIX |
375 | | -CPython |
376 | | -PyPI |
377 | | -pip |
378 | | -venv |
379 | | -IDLE |
380 | | -REPL |
381 | | -``` |
382 | | - |
383 | | ---- |
384 | | - |
385 | | -# Common Python Keywords |
386 | | - |
387 | | -Python language keywords must never be translated. |
388 | | - |
389 | | -```text |
390 | | -if |
391 | | -else |
392 | | -elif |
393 | | -for |
394 | | -while |
395 | | -class |
396 | | -def |
397 | | -return |
398 | | -import |
399 | | -from |
400 | | -try |
401 | | -except |
402 | | -finally |
403 | | -raise |
404 | | -pass |
405 | | -with |
406 | | -yield |
407 | | -lambda |
408 | | -and |
409 | | -or |
410 | | -not |
411 | | -global |
412 | | -nonlocal |
413 | | -async |
414 | | -await |
415 | | -match |
416 | | -case |
417 | | -``` |
418 | | - |
419 | | ---- |
420 | | - |
421 | | -# Language Tag |
422 | | - |
423 | | -The project uses the following IETF language tag for Punjabi: |
424 | | - |
425 | | -```text |
426 | | -pa |
427 | | -``` |
428 | | - |
429 | | -This language tag is used throughout the repository, GitHub workflows, Transifex configuration, and CPython documentation builds. |
430 | | - |
431 | | ---- |
432 | | - |
433 | | -# Consistency Rules |
434 | | - |
435 | | -To maintain a consistent translation across the project: |
436 | | - |
437 | | -- Always use glossary-approved terminology whenever an established translation exists. |
438 | | -- Do not introduce alternative translations for existing technical terms. |
439 | | -- Reuse terminology from previously completed translation files whenever possible. |
440 | | -- Function names, module names, class names, exception names, directives, roles, placeholders, and code identifiers must remain unchanged. |
441 | | -- When uncertain, prefer the terminology already used in completed translations rather than creating new variants. |
442 | | -- Follow the conventions described in `STYLE_GUIDE.md` for formatting, punctuation, and writing style. |
443 | | - |
444 | | -Consistency across the entire documentation is more important than individual translation preferences. |
445 | | - |
446 | | ---- |
447 | | - |
448 | | -# Glossary Maintenance |
449 | | - |
450 | | -This glossary is a living document and should evolve as the Punjabi translation project continues to grow. |
451 | | - |
452 | | -New terminology should be added only when: |
453 | | - |
454 | | -- A previously untranslated technical term appears in the documentation. |
455 | | -- Contributors agree on a preferred translation. |
456 | | -- The terminology has been reviewed for consistency with existing translations. |
457 | | -- The term is expected to be reused across multiple documentation files. |
458 | | - |
459 | | -When updating the glossary: |
460 | | - |
461 | | -1. Verify that the term does not already exist under a different translation. |
462 | | -2. Use the same wording consistently across all translated files. |
463 | | -3. Update existing translations if a project-wide terminology change is adopted. |
464 | | -4. Review the glossary after major translation milestones to keep terminology current. |
| 260 | +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. |
465 | 261 |
|
466 | 262 | --- |
467 | 263 |
|
468 | | -# References |
469 | | - |
470 | | -Useful resources for contributors: |
| 264 | +# Python Keywords |
471 | 265 |
|
472 | | -- **Python Developer Guide – Documentation Translations** |
473 | | - <https://devguide.python.org/documentation/translations/> |
474 | | - |
475 | | -- **Python Documentation** |
476 | | - <https://docs.python.org/> |
477 | | - |
478 | | -- **Python Documentation Style Guide** |
479 | | - <https://devguide.python.org/documentation/style-guide/> |
480 | | - |
481 | | -- **Python Documentation on Transifex** |
482 | | - <https://app.transifex.com/python-doc/python-newest/> |
483 | | - |
484 | | -- **reStructuredText Primer (Sphinx)** |
485 | | - <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html> |
| 266 | +Python keywords (`if`, `else`, `for`, `class`, `def`, `async`, `await`, `match` and so on) are never translated. |
486 | 267 |
|
487 | 268 | --- |
488 | 269 |
|
489 | | -# Final Notes |
490 | | - |
491 | | -This glossary defines the preferred terminology for the Punjabi (`pa`) translation of the Python documentation. |
492 | | - |
493 | | -All contributors are encouraged to consult this glossary before translating new documentation and to update it whenever new project-approved terminology is established. |
| 270 | +# Adding or Changing a Term |
494 | 271 |
|
495 | | -Using consistent terminology across the repository improves readability, simplifies reviews, reduces translation inconsistencies, and provides a high-quality documentation experience for Punjabi-speaking Python users. |
| 272 | +1. Check that the term is not already listed under a different translation. |
| 273 | +2. Agree on the wording with the other contributors in the pull request or an issue, and check it against existing translations. |
| 274 | +3. Add the term to the right table here and use it consistently in all translated files. |
| 275 | +4. If you change an existing term, update the translations that use it. |
0 commit comments