Skip to content

Commit f53e827

Browse files
committed
UPDATE DOCUMENTATION
1 parent 1f449c1 commit f53e827

5 files changed

Lines changed: 172 additions & 83 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,65 @@ This project follows the Python Documentation Translation Guidelines and aims to
88

99
### Completed
1010

11-
✅ Entire `tutorial/` section translated and validated.
12-
13-
Completed tutorial files:
14-
15-
* appetite.po
16-
* introduction.po
17-
* interpreter.po
18-
* controlflow.po
19-
* datastructures.po
20-
* inputoutput.po
21-
* modules.po
22-
* errors.po
23-
* classes.po
24-
* stdlib.po
25-
* stdlib2.po
11+
✅ Complete Tutorial documentation translated and validated (16 files)
12+
13+
✅ `bugs.po` fully translated and validated
14+
15+
✅ `library/functions.po` fully translated and validated
16+
17+
✅ `library/stdtypes.po` fully translated and validated
18+
19+
✅ More than 3,500 documentation messages translated
2620

2721
### Current Focus
2822

29-
The project is preparing for expansion into:
23+
Current priorities:
3024

31-
* library/
32-
* reference/
33-
* using/
34-
* whatsnew/
25+
* Transifex synchronization workflow
26+
* Python documentation translation coordination
27+
* Devguide translation listing
28+
* Reference documentation
29+
* Using Python documentation
30+
* What's New documentation
3531

3632
## Repository Structure
3733

3834
```text
3935
python-docs-pa-in/
40-
├── README.md
36+
├── .gitignore
37+
├── bugs.po
4138
├── CONTRIBUTING.md
4239
├── GLOSSARY.md
40+
├── PROJECT_REPORT.md
41+
├── README.md
4342
├── STYLE_GUIDE.md
43+
│
4444
├── .github/
4545
│ └── workflows/
4646
│ └── validate.yml
47+
│
4748
├── tutorial/
49+
│ ├── appendix.po
4850
│ ├── appetite.po
49-
│ ├── introduction.po
50-
│ ├── interpreter.po
51+
│ ├── classes.po
5152
│ ├── controlflow.po
5253
│ ├── datastructures.po
54+
│ ├── errors.po
55+
│ ├── floatingpoint.po
5356
│ ├── inputoutput.po
57+
│ ├── interactive.po
58+
│ ├── interpreter.po
59+
│ ├── introduction.po
5460
│ ├── modules.po
55-
│ ├── errors.po
56-
│ ├── classes.po
5761
│ ├── stdlib.po
58-
│ └── stdlib2.po
62+
│ ├── stdlib2.po
63+
│ ├── venv.po
64+
│ └── whatnow.po
65+
│
5966
├── library/
67+
│ ├── functions.po
68+
│ └── stdtypes.po
69+
│
6070
├── reference/
6171
├── using/
6272
└── whatsnew/
@@ -238,7 +248,7 @@ Contributors should:
238248
* Maintain terminology consistency.
239249
* Keep formatting identical to the source.
240250
* Preserve all Sphinx and reStructuredText markup.
241-
* Follow existing translation patterns established in the completed tutorial section.
251+
* Follow existing translation patterns established in completed project files (`bugs.po`, `tutorial/`, `library/functions.po`, and `library/stdtypes.po`).
242252

243253
## Getting Help
244254

‎GLOSSARY.md‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,15 @@ Contributors should use these translations consistently across all documentation
160160
| hexadecimal | ਹੈਕਸਾਡੈਸੀਮਲ |
161161
| octal | ਆਕਟਲ |
162162
| binary | ਬਾਈਨਰੀ |
163-
| precision | ਸ਼ੁੱਧਤਾ |
164-
| rounding | ਗੋਲਾਈਕਰਨ |
165-
| conversion | ਰੂਪਾਂਤਰਨ |
163+
| precision | ਸ਼ੁੱਧਤਾ |
164+
| rounding | ਗੋਲਾਈਕਰਨ |
165+
| conversion | ਰੂਪਾਂਤਰਨ |
166+
| approximation | ਅਨੁਮਾਨ |
167+
| floating-point | ਫਲੋਟਿੰਗ-ਪੌਇੰਟ |
168+
| binary fraction | ਬਾਈਨਰੀ ਭਿੰਨ |
169+
| decimal fraction | ਦਸ਼ਮਲਵ ਭਿੰਨ |
170+
| representation | ਪ੍ਰਤਿਨਿਧਿਤਾ |
171+
| representation error | ਪ੍ਰਤਿਨਿਧਿਤਾ ਗਲਤੀ |
166172

167173
---
168174

@@ -221,6 +227,10 @@ Contributors should use these translations consistently across all documentation
221227
| validation check | ਪ੍ਰਮਾਣਿਕਤਾ ਜਾਂਚ |
222228
| milestone | ਮੀਲ ਪੱਥਰ |
223229
| release tag | ਰਿਲੀਜ਼ ਟੈਗ |
230+
| validation workflow | ਪ੍ਰਮਾਣਿਕਤਾ ਵਰਕਫਲੋ |
231+
| translation workflow | ਅਨੁਵਾਦ ਵਰਕਫਲੋ |
232+
| translated file | ਅਨੁਵਾਦਿਤ ਫਾਈਲ |
233+
| completed file | ਪੂਰੀ ਕੀਤੀ ਫਾਈਲ |
224234

225235
---
226236

@@ -295,7 +305,7 @@ case
295305

296306
* Use glossary-approved terminology everywhere.
297307
* Do not invent alternative translations for existing terms.
298-
* Reuse terminology from completed files (`tutorial/`, `functions.po`, `stdtypes.po`).
308+
* Reuse terminology from completed files (`bugs.po`, `tutorial/`, `library/functions.po`, `library/stdtypes.po`).
299309
* Function names, module names, class names, exception names, and code identifiers must remain unchanged.
300310
* When uncertain, prefer the translation already used in previously completed files.
301311

@@ -305,9 +315,11 @@ case
305315

306316
| File | Messages |
307317
| -------------------- | -------: |
308-
| Tutorial (11 files) | 1,145 |
318+
| Tutorial (16 files) | 1,416 |
319+
| bugs.po | 31 |
309320
| library/functions.po | 535 |
310321
| library/stdtypes.po | 1,592 |
311-
| Total Verified | 3,272 |
322+
| Total Verified | 3,574 |
312323

313324
This glossary should be updated whenever a new major translation milestone introduces terminology that becomes part of the project's standard vocabulary.
325+

‎PROJECT_REPORT.md‎

Lines changed: 90 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
**Project:** python-docs-pa-in
44
**Coordinator:** Bhuvansh Kataria (@BHUVANSH855)
55
**Repository:** https://github.com/BHUVANSH855/python-docs-pa-in
6-
**Report Date:** June 15, 2026
7-
**Current Status:** Tutorial Section Complete
6+
**Report Date:** June 17, 2026
7+
**Current Status:** All Repository Translation Files Complete and Validated
88

99
---
1010

@@ -54,56 +54,65 @@ https://app.transifex.com/python-doc/python-newest/
5454

5555
---
5656

57-
# Tutorial Translation Progress
57+
# Translation Progress
5858

59-
## Completed Files
59+
## Tutorial Documentation
6060

6161
| File | Messages |
6262
| ----------------- | -------: |
63+
| appendix.po | 28 |
6364
| appetite.po | 17 |
64-
| interpreter.po | 33 |
65-
| introduction.po | 120 |
65+
| classes.po | 154 |
6666
| controlflow.po | 226 |
6767
| datastructures.po | 139 |
68+
| errors.po | 96 |
69+
| floatingpoint.po | 76 |
6870
| inputoutput.po | 112 |
71+
| interactive.po | 7 |
72+
| interpreter.po | 33 |
73+
| introduction.po | 120 |
6974
| modules.po | 116 |
70-
| errors.po | 96 |
71-
| classes.po | 154 |
7275
| stdlib.po | 67 |
7376
| stdlib2.po | 65 |
77+
| venv.po | 42 |
78+
| whatnow.po | 18 |
7479

75-
---
76-
77-
## Translation Statistics
78-
79-
Total Tutorial Files Completed:
80+
Tutorial Total:
8081

8182
```text
82-
11 / 11
83+
1416 messages
84+
16 files
8385
```
8486

85-
Total Translated Messages:
87+
## Root Translation Files
8688

87-
```text
88-
1145
89-
```
89+
| File | Messages |
90+
| ------- | -------: |
91+
| bugs.po | 31 |
9092

91-
Validation Status:
93+
## Library Translation Files
9294

93-
```text
94-
All files pass msgfmt --check
95-
```
95+
| File | Messages |
96+
| ------------ | -------: |
97+
| functions.po | 535 |
98+
| stdtypes.po | 1592 |
9699

97-
Untranslated Messages:
100+
## Overall Statistics
98101

99102
```text
100-
0
103+
Tutorial Messages : 1416
104+
Root Messages : 31
105+
Library Messages : 2127
106+
────────────────────────
107+
Total Messages : 3574
101108
```
102109

103-
Fuzzy Messages:
110+
Validation Status:
104111

105112
```text
106-
0
113+
0 validation errors
114+
0 fuzzy messages
115+
0 untranslated messages
107116
```
108117

109118
---
@@ -116,6 +125,9 @@ Important translation commits:
116125
416a7b5 Translate tutorial/classes.po to Punjabi
117126
e8e7b4a Add Punjabi translation for tutorial stdlib section
118127
02f4b0c Translate tutorial/stdlib2.po to Punjabi (100%)
128+
60b7420 Add Punjabi translation for library/functions.po
129+
6592723 Translate library/stdtypes.po to Punjabi
130+
a389206 Add Punjabi translations for tutorial documentation
119131
```
120132

121133
---
@@ -125,12 +137,14 @@ e8e7b4a Add Punjabi translation for tutorial stdlib section
125137
```text
126138
tutorial-phase-1
127139
tutorial-complete
140+
v1.0-tutorial-complete
128141
```
129142

130143
Tag Description:
131144

132145
* tutorial-phase-1 → Initial tutorial milestone
133146
* tutorial-complete → Entire tutorial section completed
147+
* v1.0-tutorial-complete → First validated tutorial release milestone
134148

135149
---
136150

@@ -144,16 +158,26 @@ Translation quality is maintained through:
144158
* msgfmt validation
145159
* GitHub Actions automated checks
146160

147-
Validation command:
161+
Validation commands:
148162

149163
```bash
164+
msgfmt --check bugs.po
150165
msgfmt --check tutorial/FILENAME.po
166+
msgfmt --check library/FILENAME.po
151167
```
152168

153-
Statistics command:
169+
Statistics commands:
154170

155171
```bash
156-
msgfmt --statistics tutorial/FILENAME.po
172+
msgfmt --statistics FILE.po
173+
```
174+
175+
Repository-wide validation:
176+
177+
```powershell
178+
Get-ChildItem -Recurse -Filter *.po | ForEach-Object {
179+
msgfmt --check $_.FullName
180+
}
157181
```
158182

159183
---
@@ -168,6 +192,7 @@ Contains:
168192
* Current progress
169193
* Repository structure
170194
* Workflow instructions
195+
* Current project status
171196

172197
## CONTRIBUTING.md
173198

@@ -191,6 +216,16 @@ Contains:
191216

192217
Contains approved Punjabi terminology for Python documentation.
193218

219+
## PROJECT_REPORT.md
220+
221+
Contains:
222+
223+
* Project history
224+
* Translation milestones
225+
* Statistics
226+
* Community coordination records
227+
* Future roadmap
228+
194229
---
195230

196231
# Current Repository Status
@@ -213,30 +248,42 @@ Validation:
213248
PASS
214249
```
215250

216-
Tutorial Section:
251+
Translation Status:
217252

218253
```text
219-
100% Complete
254+
All tracked translation files complete
255+
```
256+
257+
Messages Translated:
258+
259+
```text
260+
3574
220261
```
221262

222263
---
223264

224265
# Next Objectives
225266

226-
## Short Term
267+
## Coordination
268+
269+
* Finalize Transifex synchronization workflow
270+
* Confirm language identifier (`pa` vs `pa-IN`)
271+
* Coordinate with Python Documentation Translation Team
272+
* Prepare Python Devguide translation listing PR
273+
274+
## Translation Expansion
227275

228-
* Upload completed tutorial translations to Transifex
229-
* Clarify language code usage (pa vs pa-IN)
230-
* Create first project release
231-
* Expand project visibility
276+
Future target areas:
232277

233-
## Translation Targets
278+
* reference/
279+
* using/
280+
* whatsnew/
234281

235-
Recommended next files:
282+
## Long-Term Goals
236283

237-
1. bugs.po
238-
2. library/functions.po
239-
3. library/stdtypes.po
284+
* Official inclusion in Python documentation translation ecosystem
285+
* Expansion of Punjabi documentation coverage
286+
* Contributor onboarding and community growth
240287

241288
---
242289

@@ -250,6 +297,6 @@ This project aims to lower barriers for Punjabi-speaking learners and contribute
250297

251298
# Report Version
252299

253-
Version: 1.0
300+
Version: 2.0
254301

255-
Generated after completion of the entire Tutorial section of the Python documentation translation project.
302+
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.

0 commit comments

Comments
 (0)