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

Function documentation from @kelshmo review #124

Closed
4 of 5 tasks
ewallace opened this issue Nov 30, 2021 · 0 comments · Fixed by #138
Closed
4 of 5 tasks

Function documentation from @kelshmo review #124

ewallace opened this issue Nov 30, 2021 · 0 comments · Fixed by #138
Assignees
Labels
rOpensci-review To fix for rOpensci review, December 2021

Comments

@ewallace
Copy link
Collaborator

ewallace commented Nov 30, 2021

Responding to @kelshmo's review, ropensci/software-review#470 (comment)

Notes on function definitions and examples

  • Five functions have the same title "Create a blank plate template as a tibble". I can infer from the function name what is distinct, but it would be helpful to update the titles to be unique.
  • Same for five functions titled "Nice tick labels for logarithmic axes in ggplot2." (EW: I don't know if this is important enough to fix? It's not core functionality.)
  • label_plate_rowcol refers to a vignette but is not explicit which one is relevant.
  • The example for calculate_efficiency returned the warning Warning message: Unknown or uninitialised column: target_id.
  • I was confused when the documentation for create_blank_plate() populated when I was looking for make_row_names_echo1536(). This is definitely canonical but it could be helpful in the description to add some context (1 or 2 sentences).
@ewallace ewallace added the rOpensci-review To fix for rOpensci review, December 2021 label Dec 17, 2021
@DimmestP DimmestP self-assigned this Jan 11, 2022
@DimmestP DimmestP linked a pull request Jan 11, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rOpensci-review To fix for rOpensci review, December 2021
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants