Skip to content

Commit 612321b

Browse files
committed
Update project documentation for pa language tag and repository restructure
1 parent 1c25498 commit 612321b

5 files changed

Lines changed: 187 additions & 94 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,41 @@
11
# Contributing to Python Docs Punjabi (pa)
22

3-
Thank you for contributing to the Punjabi (India) translation of Python documentation.
3+
Thank you for contributing to the Punjabi (Gurmukhi) translation of the Python documentation.
44

55
This project follows the Python Documentation Translation Guidelines and aims to provide high-quality Punjabi (Gurmukhi) translations for Python learners, educators, and developers.
66

77
## Current Project Status
88

99
### Completed
1010

11-
✅ Complete Tutorial documentation translated and validated (16 files)
11+
✅ Complete Tutorial documentation translated and validated (17 files)
1212

1313
✅ `bugs.po` fully translated and validated
1414

15+
✅ `glossary.po` fully translated and validated
16+
1517
✅ `library/functions.po` fully translated and validated
1618

1719
✅ `library/stdtypes.po` fully translated and validated
1820

19-
✅ More than 3,500 documentation messages translated
21+
✅ `library/functools.po` fully translated and validated
22+
23+
✅ `library/exceptions.po` fully translated and validated
24+
25+
✅ Language tag standardized to `pa`
26+
27+
✅ All completed translations uploaded to Transifex
28+
29+
✅ 4,155 documentation messages translated
2030

2131
### Current Focus
2232

2333
Current priorities:
2434

25-
* Transifex synchronization workflow
35+
* Automated Transifex synchronization
2636
* Python documentation translation coordination
27-
* Devguide translation listing
37+
* Python Devguide translation listing
38+
* Repository structure verification
2839
* Reference documentation
2940
* Using Python documentation
3041
* What's New documentation
@@ -35,6 +46,7 @@ Current priorities:
3546
python-docs-pa/
3647
├── .gitignore
3748
├── bugs.po
49+
├── glossary.po
3850
├── CONTRIBUTING.md
3951
├── GLOSSARY.md
4052
├── PROJECT_REPORT.md
@@ -43,7 +55,8 @@ python-docs-pa/
4355
│
4456
├── .github/
4557
│ └── workflows/
46-
│ └── validate.yml
58+
│ ├── validate.yml
59+
│ └── transifex-pull.yml
4760
│
4861
├── tutorial/
4962
│ ├── appendix.po
@@ -53,6 +66,7 @@ python-docs-pa/
5366
│ ├── datastructures.po
5467
│ ├── errors.po
5568
│ ├── floatingpoint.po
69+
│ ├── index.po
5670
│ ├── inputoutput.po
5771
│ ├── interactive.po
5872
│ ├── interpreter.po
@@ -64,7 +78,9 @@ python-docs-pa/
6478
│ └── whatnow.po
6579
│
6680
├── library/
81+
│ ├── exceptions.po
6782
│ ├── functions.po
83+
│ ├── functools.po
6884
│ └── stdtypes.po
6985
│
7086
├── reference/
@@ -74,7 +90,7 @@ python-docs-pa/
7490

7591
## Workflow
7692

77-
1. Fork the repository.
93+
1. Fork the repository (external contributors).
7894
2. Create a feature branch.
7995
3. Select an untranslated `.po` file.
8096
4. Translate or review entries.
@@ -248,7 +264,7 @@ Contributors should:
248264
* Maintain terminology consistency.
249265
* Keep formatting identical to the source.
250266
* Preserve all Sphinx and reStructuredText markup.
251-
* Follow existing translation patterns established in completed project files (`bugs.po`, `tutorial/`, `library/functions.po`, and `library/stdtypes.po`).
267+
* Follow existing translation patterns established in completed project files (`bugs.po`, `glossary.po`, `tutorial/`, `library/functions.po`, `library/stdtypes.po`, `library/functools.po`, and `library/exceptions.po`).
252268

253269
## Getting Help
254270

@@ -261,4 +277,4 @@ For translation discussions, suggestions, and coordination, use GitHub Issues an
261277

262278
## License
263279

264-
Documentation translations are contributed under the same licensing framework used by the Python Documentation Translation Project.
280+
Documentation translations are contributed under the CC0 license, consistent with Python Documentation Translation project guidelines.

‎GLOSSARY.md‎

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

3-
This glossary defines preferred Punjabi translations for Python documentation terminology used throughout the Punjabi (India) translation project.
3+
This glossary defines preferred Punjabi translations for Python documentation terminology used throughout the Punjabi (Gurmukhi) translation project.
44

55
Contributors should use these translations consistently across all documentation files.
66

@@ -301,25 +301,35 @@ case
301301

302302
---
303303

304+
# Language Tag
305+
306+
The project uses the IETF language tag:
307+
308+
```text
309+
pa
310+
304311
# Consistency Rules
305312
306313
* Use glossary-approved terminology everywhere.
307314
* Do not invent alternative translations for existing terms.
308-
* Reuse terminology from completed files (`bugs.po`, `tutorial/`, `library/functions.po`, `library/stdtypes.po`).
315+
* Reuse terminology from completed files (`bugs.po`, `glossary.po`, `tutorial/`, `library/functions.po`, `library/stdtypes.po`, `library/functools.po`, and `library/exceptions.po`).
309316
* Function names, module names, class names, exception names, and code identifiers must remain unchanged.
310317
* When uncertain, prefer the translation already used in previously completed files.
311318
312319
---
313320
314321
# Current Verified Translation Milestones
315322
316-
| File | Messages |
317-
| -------------------- | -------: |
318-
| Tutorial (16 files) | 1,416 |
319-
| bugs.po | 31 |
320-
| library/functions.po | 535 |
321-
| library/stdtypes.po | 1,592 |
322-
| Total Verified | 3,574 |
323+
| File | Messages |
324+
|------|---------:|
325+
| Tutorial (17 files) | 1,436 |
326+
| bugs.po | 31 |
327+
| glossary.po | 30 |
328+
| library/functions.po | 535 |
329+
| library/stdtypes.po | 1,592 |
330+
| library/functools.po | 324 |
331+
| library/exceptions.po | 207 |
332+
| Total Verified | 4,155 |
323333
324334
This glossary should be updated whenever a new major translation milestone introduces terminology that becomes part of the project's standard vocabulary.
325335

‎PROJECT_REPORT.md‎

Lines changed: 56 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
**Project:** python-docs-pa
44
**Coordinator:** Bhuvansh Kataria (@BHUVANSH855)
55
**Repository:** https://github.com/BHUVANSH855/python-docs-pa
6-
**Report Date:** June 17, 2026
7-
**Current Status:** All Repository Translation Files Complete and Validated
6+
**Report Date:** June 22, 2026
7+
**Current Status:** All currently tracked translation files completed, validated, and uploaded to Transifex
88

99
---
1010

@@ -28,6 +28,9 @@ Completed:
2828
* GLOSSARY.md
2929
* GitHub Actions validation workflow
3030
* Repository restructuring to match Python translation recommendations
31+
* Transifex synchronization workflow
32+
* Language tag standardized to `pa`
33+
* Repository renamed to `python-docs-pa`
3134

3235
---
3336

@@ -36,13 +39,15 @@ Completed:
3639
### Python Documentation Translation Community
3740

3841
* Introduced project in Python Documentation Translation Discord
39-
* Received feedback from Stanislav Dzoba (Stan)
42+
* Received guidance and feedback from Stanislav Dzoba (Stan) and other Python documentation translation contributors
4043
* Dedicated Punjabi translation channel created
4144
* Added as Punjabi translation coordinator on Transifex
4245

4346
### Transifex
4447

45-
Language Team: Punjabi
48+
Language Team: Punjabi (pa)
49+
Translation Platform: Transifex
50+
Language Tag: pa
4651

4752
Coordinator:
4853

@@ -58,53 +63,57 @@ https://app.transifex.com/python-doc/python-newest/
5863

5964
## Tutorial Documentation
6065

61-
| File | Messages |
62-
| ----------------- | -------: |
63-
| appendix.po | 28 |
64-
| appetite.po | 17 |
65-
| classes.po | 154 |
66-
| controlflow.po | 226 |
67-
| datastructures.po | 139 |
68-
| errors.po | 96 |
69-
| floatingpoint.po | 76 |
70-
| inputoutput.po | 112 |
71-
| interactive.po | 7 |
72-
| interpreter.po | 33 |
73-
| introduction.po | 120 |
74-
| modules.po | 116 |
75-
| stdlib.po | 67 |
76-
| stdlib2.po | 65 |
77-
| venv.po | 42 |
78-
| whatnow.po | 18 |
66+
| File | Status | Messages |
67+
| ----------------- | ------------- | -------: |
68+
| appendix.po | 100% Complete | 28 |
69+
| appetite.po | 100% Complete | 17 |
70+
| classes.po | 100% Complete | 154 |
71+
| controlflow.po | 100% Complete | 226 |
72+
| datastructures.po | 100% Complete | 139 |
73+
| errors.po | 100% Complete | 96 |
74+
| floatingpoint.po | 100% Complete | 76 |
75+
| index.po | 100% Complete | 20 |
76+
| inputoutput.po | 100% Complete | 112 |
77+
| interactive.po | 100% Complete | 7 |
78+
| interpreter.po | 100% Complete | 33 |
79+
| introduction.po | 100% Complete | 120 |
80+
| modules.po | 100% Complete | 116 |
81+
| stdlib.po | 100% Complete | 67 |
82+
| stdlib2.po | 100% Complete | 65 |
83+
| venv.po | 100% Complete | 42 |
84+
| whatnow.po | 100% Complete | 18 |
7985

8086
Tutorial Total:
8187

8288
```text
83-
1416 messages
84-
16 files
89+
1436 messages
90+
17 files
8591
```
8692

8793
## Root Translation Files
8894

89-
| File | Messages |
90-
| ------- | -------: |
91-
| bugs.po | 31 |
95+
| File | Messages |
96+
|------|---------:|
97+
| bugs.po | 31 |
98+
| glossary.po | 30 |
9299

93100
## Library Translation Files
94101

95-
| File | Messages |
96-
| ------------ | -------: |
97-
| functions.po | 535 |
98-
| stdtypes.po | 1592 |
102+
| File | Messages |
103+
|------|---------:|
104+
| functions.po | 535 |
105+
| stdtypes.po | 1592 |
106+
| functools.po | 324 |
107+
| exceptions.po | 207 |
99108

100109
## Overall Statistics
101110

102111
```text
103-
Tutorial Messages : 1416
104-
Root Messages : 31
105-
Library Messages : 2127
112+
Tutorial Messages : 1436
113+
Root Messages : 61
114+
Library Messages : 2658
106115
────────────────────────
107-
Total Messages : 3574
116+
Total Messages : 4155
108117
```
109118

110119
Validation Status:
@@ -122,12 +131,15 @@ Validation Status:
122131
Important translation commits:
123132

124133
```text
125-
416a7b5 Translate tutorial/classes.po to Punjabi
126-
e8e7b4a Add Punjabi translation for tutorial stdlib section
127-
02f4b0c Translate tutorial/stdlib2.po to Punjabi (100%)
128134
60b7420 Add Punjabi translation for library/functions.po
129135
6592723 Translate library/stdtypes.po to Punjabi
130136
a389206 Add Punjabi translations for tutorial documentation
137+
f9debcc Translate tutorial/index.po to Punjabi
138+
6f06b8e Add Punjabi translation for functools module
139+
a894748 Translate glossary.po to Punjabi
140+
344ee62 Translate library/exceptions.po
141+
87f8012 Use pa language code across repository
142+
1c25498 Rename repository references to python-docs-pa
131143
```
132144

133145
---
@@ -162,6 +174,7 @@ Validation commands:
162174

163175
```bash
164176
msgfmt --check bugs.po
177+
msgfmt --check glossary.po
165178
msgfmt --check tutorial/FILENAME.po
166179
msgfmt --check library/FILENAME.po
167180
```
@@ -251,13 +264,13 @@ PASS
251264
Translation Status:
252265

253266
```text
254-
All tracked translation files complete
267+
All currently tracked translation files complete and validated
255268
```
256269

257270
Messages Translated:
258271

259272
```text
260-
3574
273+
4155
261274
```
262275

263276
---
@@ -266,7 +279,7 @@ Messages Translated:
266279

267280
## Coordination
268281

269-
* Finalize Transifex synchronization workflow
282+
* Automate Transifex synchronization workflow
270283
* Coordinate with Python Documentation Translation Team
271284
* Prepare Python Devguide translation listing PR
272285

@@ -296,6 +309,6 @@ This project aims to lower barriers for Punjabi-speaking learners and contribute
296309

297310
# Report Version
298311

299-
Version: 2.0
312+
Version: 2.1
300313

301-
Generated after completion and validation of all currently tracked translation files in the repository, including Tutorial documentation, bugs.po, library/functions.po, and library/stdtypes.po.
314+
Generated after completion and validation of all currently tracked translation files in the repository, including Tutorial documentation, bugs.po, glossary.po, library/functions.po, library/stdtypes.po, library/functools.po, and library/exceptions.po. All completed translations have also been uploaded to the Python Documentation Transifex project.

0 commit comments

Comments
 (0)