docs: fix is_*() return value for nonexistent paths (#516)#517
Open
LeonidasZhak wants to merge 1 commit into
Open
docs: fix is_*() return value for nonexistent paths (#516)#517LeonidasZhak wants to merge 1 commit into
LeonidasZhak wants to merge 1 commit into
Conversation
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.
Summary
The documentation for
is_file(),is_dir(),is_link(), andis_file_empty()states thatNAis returned for nonexistent paths. The actual behavior (since at least the current implementation) is to returnFALSE.This PR updates the
@returndocumentation to match the implementation.Related issue
Fixes #516
Changes
R/is.R:4— ChangeNAtoFALSEin@returnroxygen tagman/is_file.Rd:26— Regenerated Rd matching the roxygen sourceValidation
tools::checkRd('man/is_file.Rd')passes with no warningsReproducible example