Fix \usage truncation for long (>20-line) function signatures#14
Merged
Conversation
parse_file() captured only a fixed 20-line window after a definition, so a function whose signature spans more lines (e.g. a 49-arg signature) was cut mid-list, failed to parse, and fell back to names-without-defaults -- producing an incomplete \usage and R CMD check codoc mismatches. Read until the signature parentheses balance instead. Adds a regression test.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
parse_file()looked ahead a fixed 20 lines to capture a function's signature, so any function whose formals span more than ~20 lines was truncated mid-argument. The partial text failed to parse and fell back to names-without-defaults, yielding an incomplete\usage{}andR CMD checkcodoc mismatches (hit while migrating tinyspotifyr, whoseget_recommendationshas 49 args).Fix: read forward until the signature's parentheses balance instead of a fixed window (one-liners stop after their first line). Adds a regression test for a 30-arg multi-line signature. Full suite: 148 pass.