pkgdown icon indicating copy to clipboard operation
pkgdown copied to clipboard

Mimic R-4 documentation for Usage

Open msberends opened this issue 3 years ago • 4 comments

Fixes #2187 - mimics the comments in Usage as seen in R-4 documentation.

msberends avatar Sep 02 '22 10:09 msberends

Is this worth doing given that it will require updates to all translations? I don't think the new comment is that much of an improvement.

hadley avatar Oct 17 '23 17:10 hadley

For consistency matters, I think it is. The actual question is: why was chosen for this format in the first place?

It is only one string, and translations are of course very easy to alter - we now have LLMs that can do that for us if need be. Even if done manually, it's only a handful of translations.

msberends avatar Oct 17 '23 17:10 msberends

Sure, it's a handful of translations, but it means reaching out to all the existing translators to get updates. IMO, it's a change with only a small positive impact that is going to take a few hours of my and others time to coordinate.

hadley avatar Oct 17 '23 19:10 hadley

I can absolutely see that of course. It is indeed something small. I discussed creating this PR with @maelle in #2187, but it’s up to you what you do with it :)

I’m also careful about investing my time, I really understand your POV. On the other hand, if small bugs/inconsistencies are often left as is, they accumulate to a lot of garbage at a certain point.

I’m okay with any decision you make!

msberends avatar Oct 18 '23 06:10 msberends

Coming back to this with fresh eyes, I think this is worthwhile, but only in a minor release when we might introduce new translations, and will need to let existing translators know that their help is needed once again.

hadley avatar Apr 18 '24 22:04 hadley