Refine how macros are discovered #37
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgkf-roche
suggested changes
Oct 18, 2024
There was a problem hiding this comment.
I think a more explicit test is warranted to try to cover this case, but otherwise all the changes look really good. If you haven't used macros before, I can take this on. With a bit of background on the topic it should be a reasonably straightforward test to add.
Comment on lines
+15
to
+17
| rd_macro <- system.file("examples", "macros", "macros.Rd", package = "rd2markdown") | ||
| expect_s3_class(get_rd(file = rd_filepath, macros = rd_macro), "Rd") | ||
| expect_silent(rd <- get_rd(file = rd_filepath, macros = rd_macro)) |
There was a problem hiding this comment.
This test doesn't really test the discovery of package macros, which is a pretty central feature here. Can we also add a test for a macro we embed in this package?
You can see a trivial macro here in a package I was working on recently.
We could test it easily by using it in the package docs themselves or alternatively creating a tiny fixture package to test it against.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is my attempt to address macro problems. It's still a bit new to me, but it should solve our current issue with the roxyreqs package; at least my tests confirm that.