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

Roxygen won't write .Rd file unless I change .R file name #1674

Open
jdprimus opened this issue Nov 2, 2024 · 0 comments
Open

Roxygen won't write .Rd file unless I change .R file name #1674

jdprimus opened this issue Nov 2, 2024 · 0 comments

Comments

@jdprimus
Copy link

jdprimus commented Nov 2, 2024

I can't really provide a reproducible example for this, but it's simple enough to describe

I have a function called write_docs.R. I am trying to deprecate this function and update the documentation to reflect. I know how to do this. For some reason, this documentation won't write. I tried deleting the .Rd file--still doesn't write the .Rd.

However, I have discovered that if I change the NAME of the .R file (not the content in any way) to write_doc.R--it works perfectly. If I change the filename back to write_docs.R it deletes the .Rd file and removes it from my <package>-deprecated .Rd.

There must be some sort of hidden file or artifact that won't allow me to write the .Rd file that was previously generated by write_docs.R. I can delete the whole /man directory, and it still won't write it. I have been playing around with the internal roxygen2 functions, but I can't find where this hidden file or artifact would be referenced. I think this is a bug. I can of course, keep the name write_doc.R, but I prefer to have my filenames match my function names. Can someone tell me where to look, what to delete such that I can generate docs for the appropriately named file?

Running roxygen2 version 7.2.3. Thanks!

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