Update README.fr.rst (fix typos, `pygame` => `pygame-ce` ...) #2228

bilhox · 2023-06-04T18:09:33Z

Hi,

Again, I propose a PR to fix some typos, some pygame got updated to pygame-ce, and finally, some sentences got a bit changed to look more natural.

Should be reviewed by @Grimmys

docs/readmes/README.fr.rst

Grimmys · 2023-06-04T18:33:29Z

No blocker on my side, just suggestions.

oddbookworm · 2023-06-04T19:23:27Z

docs/readmes/README.fr.rst

@@ -198,7 +198,8 @@ Voir les docs/licences pour les licences des dépendances.
 .. |BlackFormatBadge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

-.. _pygame: https://pyga.me
+.. _pygame: https://www.pygame.org/docs/


Why are we linking to the original docs?

It's for the thanks:

"[...] et ajoutant du nouveau contenu dans le wiki de pygame_ et sur pygame-ce_. "

Meaning:

"[...] and thanks to the people adding new content in pygame and pygame-ce wikis", with links to them.

If we don't want to link to the original docs, then should we remove the thanks for pygame as well?

That's fair, and I'm fine with it. However, I want to be careful about slight content changes between the versions of the readmes as well. I'm fine with it, as long as all versions of the readme stay consistent with each other

I definitely agree with you, I was starting to think about this issue as well.

But then, what should be the process?
We should always have the English original version in sight next to the translation changes when reviewing them, and if we want to suggest change meaningful for both versions, it should first be applied to the English one?

The more translations we have, the harder this will be to manage. I'm not sure what the best approach would be. Ideally, they'd all be changed at the same time so they're all always in sync, but that's just not feasible

I don't think we should deviate from the original source too much.

Okay then should I make the same changes to the english readme ? (replacing specific pygame to pygame-ce, and make pygame(-ce) links redirecting to the docs instead of main page)

bilhox · 2023-06-06T17:07:48Z

I added a warning about french README content.
Is there anything left to do ?

Starbuck5 · 2023-06-18T08:36:15Z

Here's the policy I envision for updating the READMEs.

Non-English READMEs are just trying to follow the English README's content.
Whoever updates the English README has the responsibility to mark all other READMEs as out of date (in English)
Translators see the README is out of date and update and update it (they can check the git history on the English README to find what changed). Or they don't, and maybe after a view years of that the Non-English README will be removed for lack of maintenance.

So you want to make a content change to the README?
You need to make it to the English README, then mark all other READMEs as out of date.

In your case, you can make the update to the English README and the French README then mark all other READMEs as out of date.

Starbuck5 · 2023-07-11T08:40:55Z

@bilhox lets move this forward.

Content changes you've made to the French README should be added to the English README, and you should mark each other translation as out of date.

bilhox · 2023-07-11T08:44:40Z

Hello,

Okay (I forgot about this PR sorry 😅), shall I also add the policy you envisaged in your last message, directly in the readme ?

Starbuck5 · 2023-07-11T08:46:21Z

I don't think it's necessary to explain the README update policy in the README. We could have a README-README for that 😄

Don't worry about it in this PR.

bilhox · 2023-07-11T09:31:36Z

Okay, I added what you wanted. I updated the english README, and warned people ni the french readme that it could be out of date. For the korean (I guess ?) and persian readme, @yolowex and @yunline shall update them.

yolowex · 2023-07-11T09:38:31Z

Okay, I added what you wanted. I updated the english README, and warned people ni the french readme that it could be out of date. For the korean (I guess ?) and persian readme, @yolowex and @yunline shall update them.

Sure thing, thanks for the tag

Starbuck5 · 2023-07-15T09:59:39Z

docs/readmes/README.fr.rst

+**Des différences de contenus peuvent être présentes entre le README français, et anglais. Prenez donc bien soin de vérifier les informations de ce README avec le README anglais.**
+---------------------------------------------------------------------------------------------------


Why mark this README out of date? Did you make different changes to the English one and the French one?

If you change the English source and also the French translation, it's every other README that's out of date.

No, it is not saying that this README is out of date, but that it might be at any point in time.

It's more like a safeguard, warning people that they should not 100% trust the content of translation README files.

I think it's the policy you were talking about and then said it should not be added in the README file itself, maybe they just mixed up what you explained.

Why mark this README out of date? Did you make different changes to the English one and the French one?

If you change the English source and also the French translation, it's every other README that's out of date.

I updated also the English README (just added some web-links as I did in the French README).
As he said grimmys, the message says it could be out dated" (maybe I'll make it smaller).
Concerning other READMEs, yunline and yolowex got pinned in a message I sent a couple days ago, so they can change their README.

What's the point of having translated READMEs if we just put generic disclosures that they could be out of date at the top?
Especially since we actually know it's not out of date right now.

If this PR goes through the other READMEs actually will be out of date, so they should get some sort of warning or notice for translators.

So basically, the best I can do is removing this text in the French README, and mark each other README translation as out of date ?

bilhox · 2023-08-03T19:59:24Z

Ready for reviews

README.rst

docs/readmes/README.fr.rst

README.rst

MyreMylar

Overall these changes seem fine to me.

I suggest removing the links to both the old and new pygame wikis at the top of the links list as both are targeted more towards in-depth developers of pygame rather than average pygame enjoyers and we already have a link to the compilation part of the most recent wiki.

README.rst

docs/readmes/README.fr.rst

Changes made

Starbuck5

Still doesn't have the warning message in the other readmes to tell translators to update, but at this point I just want to merge this in to resolve the conversation.

Update README.fr.rst

bd4be11

bilhox requested a review from a team as a code owner June 4, 2023 18:09

oddbookworm previously requested changes Jun 4, 2023

View reviewed changes

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

Grimmys reviewed Jun 4, 2023

View reviewed changes

docs/readmes/README.fr.rst Show resolved Hide resolved

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

bilhox added 2 commits June 4, 2023 20:51

Update README.fr.rst

ffdba6a

dependencies fix

88871d8

oddbookworm reviewed Jun 4, 2023

View reviewed changes

bilhox added 2 commits June 6, 2023 19:00

Merge branch 'pygame-community:main' into patch-1

3ae4982

Added a warning about french readme content

ccf5a48

yunline added the docs label Jun 12, 2023

bilhox added 6 commits July 11, 2023 10:59

fixes 1

f8ed3ee

Compatibility with the french readme

69638d3

link fixes (french)

1d33fdc

test

eaa4c0d

link fixes

fcdbc9b

link fixes 3 (english)

59799d5

Starbuck5 reviewed Jul 15, 2023

View reviewed changes

bilhox added 5 commits August 3, 2023 21:48

Merge branch 'main' into patch-1

a89884b

Update README.zh-cn.rst

c1a7a9e

Update README.fr.rst

2bff5d0

Update README.fa.rst

ae75756

Update README.rst

c1e0168

bilhox added 2 commits August 3, 2023 21:56

Update README.fr.rst

289a7fd

Update README.fr.rst

c9f2d41

MyreMylar reviewed Aug 14, 2023

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Fix link to old pygame wiki

427dab6

MyreMylar reviewed Aug 14, 2023

View reviewed changes

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

update old pygame wiki link

ef7b1b9

MyreMylar reviewed Aug 14, 2023

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Fix link to pygame-ce wiki

6d8418e

MyreMylar approved these changes Aug 14, 2023

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

docs/readmes/README.fr.rst Outdated Show resolved Hide resolved

bilhox added 2 commits August 14, 2023 16:24

Update README.fr.rst - fixed links

2387c6b

Update README.rst - fixed links

0b8cc40

Starbuck5 approved these changes Aug 27, 2023

View reviewed changes

Starbuck5 merged commit d1fa34f into pygame-community:main Aug 27, 2023
2 checks passed

Starbuck5 added this to the 2.4.0 milestone Aug 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.fr.rst (fix typos, `pygame` => `pygame-ce` ...) #2228

Update README.fr.rst (fix typos, `pygame` => `pygame-ce` ...) #2228

bilhox commented Jun 4, 2023

Grimmys commented Jun 4, 2023

oddbookworm Jun 4, 2023

Grimmys Jun 4, 2023

oddbookworm Jun 4, 2023

Grimmys Jun 4, 2023

oddbookworm Jun 4, 2023

novialriptide Jun 17, 2023 •

edited

bilhox Jun 17, 2023

bilhox commented Jun 6, 2023

Starbuck5 commented Jun 18, 2023

Starbuck5 commented Jul 11, 2023

bilhox commented Jul 11, 2023

Starbuck5 commented Jul 11, 2023

bilhox commented Jul 11, 2023

yolowex commented Jul 11, 2023

Starbuck5 Jul 15, 2023

Grimmys Jul 15, 2023

bilhox Jul 15, 2023

Starbuck5 Jul 16, 2023 •

edited

bilhox Jul 16, 2023

bilhox commented Aug 3, 2023

MyreMylar left a comment

Starbuck5 left a comment

		Des différences de contenus peuvent être présentes entre le README français, et anglais. Prenez donc bien soin de vérifier les informations de ce README avec le README anglais.
		---------------------------------------------------------------------------------------------------

Update README.fr.rst (fix typos, pygame => pygame-ce ...) #2228

Update README.fr.rst (fix typos, pygame => pygame-ce ...) #2228

Conversation

bilhox commented Jun 4, 2023

Grimmys commented Jun 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novialriptide Jun 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bilhox commented Jun 6, 2023

Starbuck5 commented Jun 18, 2023

Starbuck5 commented Jul 11, 2023

bilhox commented Jul 11, 2023

Starbuck5 commented Jul 11, 2023

bilhox commented Jul 11, 2023

yolowex commented Jul 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Starbuck5 Jul 16, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bilhox commented Aug 3, 2023

MyreMylar left a comment

Choose a reason for hiding this comment

Starbuck5 left a comment

Choose a reason for hiding this comment

Update README.fr.rst (fix typos, `pygame` => `pygame-ce` ...) #2228

Update README.fr.rst (fix typos, `pygame` => `pygame-ce` ...) #2228

novialriptide Jun 17, 2023 •

edited

Starbuck5 Jul 16, 2023 •

edited