docs: add @return, @details, and example to type_convert() documentation - #1637
Closed
LeonidasZhak wants to merge 1 commit into
Closed
docs: add @return, @details, and example to type_convert() documentation#1637LeonidasZhak wants to merge 1 commit into
LeonidasZhak wants to merge 1 commit into
Conversation
- Add @return tag documenting that unparsable values become NA with a warning - Add @details explaining that guess_parser() is used for type guessing - Note that numeric parser recognizes some alphanumeric strings (e.g., '100e5', '100L', '100S') as valid numbers - Add example showing parsing failure with explicit col_types Addresses tidyverse#1562 (partially - documentation of behavior, not the underlying parser bug)
Author
|
Withdrawing this small automated PR while I consolidate an oversized batch of contributions and reduce maintainer review burden. Sorry for the noise, and thank you for maintaining the project. |
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
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.
What
Adds missing documentation to
type_convert():@return tag: Documents that the function returns a data frame with character columns converted to guessed types, and that unparsable values become
NAwith a warning.@details section: Explains that column types are guessed using
guess_parser(), and notes that the numeric parser recognizes some alphanumeric strings as valid numbers (e.g.,"100e5","100L","100S"). Suggests using explicitcols()specifications to avoid unexpected parsing.Example: Shows parsing failure with explicit
col_types = cols(x = col_double()).Why
Partially addresses #1562. While the underlying Qi parser behavior (treating F/L/S as floating-point suffixes) requires a C++ code fix, this PR documents the current behavior so users can understand and work around it.
Validation
tools::checkRd("man/type_convert.Rd")— cleanFiles changed
R/type_convert.R(roxygen source)man/type_convert.Rd(generated)