Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mimic R-4 documentation for Usage #2189

Merged
merged 8 commits into from
Apr 19, 2024
Merged

Mimic R-4 documentation for Usage #2189

merged 8 commits into from
Apr 19, 2024

Conversation

msberends
Copy link
Contributor

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

@maelle maelle added this to the 2.1.0 milestone Oct 20, 2022
@hadley
Copy link
Member

hadley commented Oct 17, 2023

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.

@msberends
Copy link
Contributor Author

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.

@hadley
Copy link
Member

hadley commented Oct 17, 2023

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.

@msberends
Copy link
Contributor Author

msberends commented Oct 18, 2023

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!

@hadley hadley modified the milestones: 2.0.8, 2.0.9 Mar 12, 2024
@hadley
Copy link
Member

hadley commented Apr 18, 2024

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 hadley merged commit 6c455ba into r-lib:main Apr 19, 2024
12 checks passed
SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this pull request Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace “S3 method for default”?
3 participants