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

Mention walk2() in map2.R documentation Value section #1153

Open
mfeinleib-hart opened this issue Oct 8, 2024 · 0 comments
Open

Mention walk2() in map2.R documentation Value section #1153

mfeinleib-hart opened this issue Oct 8, 2024 · 0 comments
Labels

Comments

@mfeinleib-hart
Copy link

The documentation in map2.R inherits from map.R for the Value section:

#' @inherit map return

This is okay for the first 3 bullets. However, for the final bullet, the map2.R documentation still refers to walk() instead of walk2():

walk() returns the input .x (invisibly). This makes it easy to use in a pipe. The return value of .f() is ignored.

I think it's important to specify that walk2() returns the first of its two arguments, (fortunately still named .x). It's a small change, but it clarifies behavior that could be potentially confusing.

Link to online map2.R documentation

@hadley hadley added the upkeep label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants