Skip to content
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

Documentation edits in split.R Examples #519

Closed
feinleib opened this issue Aug 1, 2023 · 2 comments
Closed

Documentation edits in split.R Examples #519

feinleib opened this issue Aug 1, 2023 · 2 comments

Comments

@feinleib
Copy link

feinleib commented Aug 1, 2023

This is related to issue #500. I initially commented there, but I'm creating a new issue because PR #502 already fixed that issue.

I have two more fixes in the Examples section of split.R documentation:

  1. The comment for str_split_1() is missing the second underscore.
# If you want to split a single string, use `str_split1`
  1. The names of the functions are written differently in each comment. These should be made consistent with each other.
# If you want to split a single string, use `str_split1`
# Use fixed to return a character matrix
# str_split_i extracts only a single piece from a string

My understanding of the relevant section of the Tidyverse Style Guide is that the correct format for these comments is backticked, with trailing parentheses:

`str_split_1()`     `str_split_fixed()`     `str_split_i()`
@hadley
Copy link
Member

hadley commented Aug 4, 2023

Would you like to do a PR to fix this?

@hadley
Copy link
Member

hadley commented Oct 31, 2023

Fixed by #526

@hadley hadley closed this as completed Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants