Skip to content

Remove usage of internal function in CI tests #2597

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

Merged
merged 4 commits into from
Jun 8, 2024
Merged

Conversation

IndrajeetPatil
Copy link
Collaborator

cf. #1692

#' @param source_expression A source_expression.
#' @param token_type Restrict analysis to tokens of this type, for example,
#' with `token_type = "STR_CONST"` you can check that a regex match occurs
#' within a string.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related, but minor docs clean-up. Didn't want to create a separate PR just for this change.

#' with token_type = "STR_CONST" you can check that a regex match occurs
#' within a string
#' @param match The position where a regex match was observed.
#' Possible values: `"start"`, `"end"`, and `"line_number"`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this is not the correct way to document the required entries.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this is an internal function, and we don't even generate the .Rd file.

What change would you like me to make?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me the old doc was fine.
The attributes are required, not optional. "Possible" suggests otherwise.

Copy link

codecov bot commented Jun 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.08%. Comparing base (fc2268f) to head (5c37d71).
Report is 8 commits behind head on main.

Current head 5c37d71 differs from pull request most recent head ca96639

Please upload reports for the commit ca96639 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2597      +/-   ##
==========================================
- Coverage   98.15%   98.08%   -0.07%     
==========================================
  Files         125      126       +1     
  Lines        5738     5740       +2     
==========================================
- Hits         5632     5630       -2     
- Misses        106      110       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@IndrajeetPatil IndrajeetPatil added the internals Issues related to inner workings of lintr, i.e., not user-visible label Jun 8, 2024
@AshesITR AshesITR merged commit 5a53252 into main Jun 8, 2024
20 checks passed
@AshesITR AshesITR deleted the test-ci-remove-internal branch June 8, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internals Issues related to inner workings of lintr, i.e., not user-visible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants