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.

Sign up for GitHub

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

Jump to bottom

Vignettes #320

Closed
2 tasks done
chainsawriot opened this issue Aug 30, 2023 · 5 comments
Closed
2 tasks done

Vignettes #320

chainsawriot opened this issue Aug 30, 2023 · 5 comments
Assignees
@chainsawriot
Labels
documentation v1.0

Comments

@chainsawriot
Copy link
Collaborator

chainsawriot commented Aug 30, 2023 •
edited
Loading

ref ropensci/software-review#605

  • Internal function arg_reconcile is not exported; but got processed by Roxygen and got a MAN page (which shouldn't)

https://github.com/chainsawriot/rio/blob/01e55d2fd6dd1ee8c59ea782541d57353621d3c1/R/arg_reconcile.R#L1-L48

  • .import and .export should not be exported

https://github.com/chainsawriot/rio/blob/01e55d2fd6dd1ee8c59ea782541d57353621d3c1/R/extensions.R#L15

If the purpose is for documenting how to write extensions, it should be a vignette.
chainsawriot added a commit that referenced this issue Aug 30, 2023
@chainsawriot
Remove the doc of arg_reconcile [no ci] ref #320 ropensci/software-…
0108962 
…review#605
chainsawriot added a commit that referenced this issue Aug 30, 2023
@chainsawriot
Unexport .export .import ref #320 ropensci/software-review#605
325fce3 
Pending: write a Vignette instead
@chainsawriot
Copy link
Collaborator Author

chainsawriot commented Aug 30, 2023 •
edited
Loading

  • rewrite the comment in extensions.R as a vignette

@chainsawriot chainsawriot changed the title Unexport functions / objects Rewrite the comment in extensions.R as a vignette Aug 30, 2023
@chainsawriot chainsawriot changed the title Rewrite the comment in extensions.R as a vignette Rewrite the comment in extensions.R as vignette Aug 30, 2023
@chainsawriot chainsawriot mentioned this issue Sep 3, 2023
Open
@chainsawriot chainsawriot self-assigned this Sep 5, 2023
@chainsawriot chainsawriot changed the title Rewrite the comment in extensions.R as vignette Vignettes Sep 6, 2023
@chainsawriot
Copy link
Collaborator Author

chainsawriot commented Sep 6, 2023 •
edited
Loading

  • Package philosophy
  • Working with labelled data

@chainsawriot
Copy link
Collaborator Author

chainsawriot commented Sep 6, 2023 •
edited
Loading

?

  • FAQs - Searching all the issues and identify them e.g. system dependencies (Linux)

@chainsawriot
Copy link
Collaborator Author

chainsawriot commented Sep 6, 2023 •
edited
Loading

  • Remapping behaviors

chainsawriot added a commit that referenced this issue Sep 6, 2023
@chainsawriot
Make Package Philosphy a vignette ref #320
65e96b2
chainsawriot added a commit that referenced this issue Sep 6, 2023
@chainsawriot
Make Package Philosphy a vignette [no ci] ref #320 (#342)
37fa081 
* Make `Package Philosphy` a vignette ref #320

* Update NEWS.md [no ci]
@chainsawriot
Copy link
Collaborator Author

Maybe the FAQs should put here instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chainsawriot chainsawriot

Labels
documentation v1.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chainsawriot