Skip to content

Delete README translations - #3716

Merged
oddbookworm merged 1 commit into
pygame-community:mainfrom
Matiiss:matiiss-nuke-readme-translations
May 8, 2026
Merged

oddbookworm merged 1 commit into
pygame-community:mainfrom
Matiiss:matiiss-nuke-readme-translations

Conversation

@Matiiss

@Matiiss Matiiss commented Feb 17, 2026

Copy link
Copy Markdown
Member

They are outdated and mostly unmaintained
And they don't add much value to the project

Closes #3646

@Matiiss
Matiiss requested a review from a team as a code owner February 17, 2026 18:52
@Matiiss Matiiss added the docs label Feb 17, 2026
@coderabbitai

coderabbitai Bot commented Feb 17, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5206ed3a-4fc8-4c50-833b-560073122bc0

📥 Commits

Reviewing files that changed from the base of the PR and between 5de22d3 and c01c1cd.

📒 Files selected for processing (12)
  • README.rst
  • docs/readmes/README.de.rst
  • docs/readmes/README.es.rst
  • docs/readmes/README.fa.rst
  • docs/readmes/README.fr.rst
  • docs/readmes/README.gr.rst
  • docs/readmes/README.it.rst
  • docs/readmes/README.ja.rst
  • docs/readmes/README.pt-br.rst
  • docs/readmes/README.ru.rst
  • docs/readmes/README.zh-cn.rst
  • docs/readmes/README.zh-tw.rst
💤 Files with no reviewable changes (12)
  • docs/readmes/README.gr.rst
  • docs/readmes/README.fr.rst
  • docs/readmes/README.zh-tw.rst
  • docs/readmes/README.ja.rst
  • docs/readmes/README.zh-cn.rst
  • docs/readmes/README.it.rst
  • docs/readmes/README.fa.rst
  • docs/readmes/README.ru.rst
  • docs/readmes/README.es.rst
  • README.rst
  • docs/readmes/README.pt-br.rst
  • docs/readmes/README.de.rst

📝 Walkthrough

Walkthrough

Removes the multilingual language-navigation header from README.rst and deletes 11 localized README files under docs/readmes/ (German, Spanish, Persian, French, Greek, Italian, Japanese, Portuguese-BR, Russian, zh-cn, zh-tw), eliminating those translation documents and their anchor targets.

Changes

Cohort / File(s) Summary
Main README header
README.rst
Removed the multilingual localization header block and the 11 locale anchor definitions (language navigation anchors removed).
Deleted localized READMEs
docs/readmes/README.de.rst, docs/readmes/README.es.rst, docs/readmes/README.fa.rst, docs/readmes/README.fr.rst, docs/readmes/README.gr.rst, docs/readmes/README.it.rst, docs/readmes/README.ja.rst, docs/readmes/README.pt-br.rst, docs/readmes/README.ru.rst, docs/readmes/README.zh-cn.rst, docs/readmes/README.zh-tw.rst
Removed entire localized README files (static documentation only). Reviewers should check for stale links or documentation references elsewhere that pointed to these files or anchors.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • oddbookworm
  • ankith26
🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR stays focused on removing README translation files; however, README.it.rst includes unrelated declarations about Calculator methods and variables that appear extraneous. Remove the unrelated code declarations (coderabbit_add, coderabbit_formula signature change, and variable rename) that should not be part of this documentation-only PR.
Linked Issues check ❓ Inconclusive The PR deletes all translated README files rather than implementing any of the three alternatives proposed in issue #3646, which partially diverges from the issue's suggested solutions. Clarify whether deleting all translations aligns with the issue's intent or if it represents a decision to pursue a fourth alternative not originally discussed.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the primary change: deleting README translations across multiple languages.
Description check ✅ Passed The description explains the rationale for the changes and references the related issue, providing context for the deletions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can disable sequence diagrams in the walkthrough.

Disable the reviews.sequence_diagrams setting to disable sequence diagrams in the walkthrough.

@robotsnh

Copy link
Copy Markdown

@Matiiss I personally think that this allows those who don't speak English to add value to this project.

@oddbookworm

Copy link
Copy Markdown
Member

@robotsnh sure, but what about the ongoing maintenance requirements of the translations? They're all in different levels of "up-to-date" with the English README because someone hasn't happened to swing by and drop an update

@oddbookworm

Copy link
Copy Markdown
Member

Plus, all of the documentation is in English, so if someone doesn't have the English skills to read the readme, then I've got some unfortunate news in that the docs are going to be nearly impossible to read

@robotsnh

Copy link
Copy Markdown

@oddbookworm Fair enough. In addition, people can use Google Translate.

@Matiiss
Matiiss force-pushed the matiiss-nuke-readme-translations branch from 5de22d3 to c01c1cd Compare March 14, 2026 21:44

@oddbookworm oddbookworm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to agree with this move for the reasons mentioned already in the comments. But I think the decision to move forward with this should be left to the new steering council after the election

@aatle aatle left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this change, pygame-ce's language translation does not currently extend past the README, and maintenance is very difficult.

@oddbookworm
oddbookworm merged commit 432fdd0 into pygame-community:main May 8, 2026
21 checks passed
@oddbookworm oddbookworm added this to the 2.5.8 milestone May 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inconsistency in README translations

4 participants