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

adopt @generated marker for generated *.Rd files #1678

Open
maxheld83 opened this issue Nov 12, 2024 · 0 comments
Open

adopt @generated marker for generated *.Rd files #1678

maxheld83 opened this issue Nov 12, 2024 · 0 comments

Comments

@maxheld83
Copy link
Member

maxheld83 commented Nov 12, 2024

instead of:

% Generated by roxygen2: do not edit by hand

it should read:

% @generated by roxygen2: do not edit by hand

This is the https://generated.at standard.

It's meant for specifically the roxygen2 situation: Generated files which (regrettably) get committed to git (.gitignore).

Potential consumers of this information might be linters, editors and other dev tooling.

Happy to add a PR to this effect, since that should be quite trivial.

Only issue: should this ever be adopted, a lot of people would have one-off spurious diffs in their man/, which would be a nuisance.

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

No branches or pull requests

1 participant