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

review exported functions #104

Closed
JanMarvin opened this issue Mar 26, 2022 · 1 comment
Closed

review exported functions #104

JanMarvin opened this issue Mar 26, 2022 · 1 comment
Assignees
Milestone

Comments

@JanMarvin
Copy link
Owner

guess column type must not be exported as well as probably a bunch of other functions. Currently defunct functions should not be exported either.

@JanMarvin JanMarvin added this to the v0.2.0 rc1 milestone Mar 26, 2022
@JanMarvin JanMarvin self-assigned this Mar 26, 2022
@JanMarvin JanMarvin mentioned this issue Sep 9, 2022
8 tasks
@JanMarvin JanMarvin modified the milestones: v0.2.0 rc1, v0.5 Dec 6, 2022
@JanMarvin JanMarvin modified the milestones: v0.5, v0.6 Jan 29, 2023
@olivroy
Copy link
Collaborator

olivroy commented Jul 3, 2023

Before starting removing functions are removing @export tags, you could also add a bunch of @keywords internal roxygen tags to functions you don't think should be used, are part of the wanted API.

This will have the benefit of removing these functions from the reference list (decluttering https://janmarvin.github.io/openxlsx2/reference/index.html and in R) while keeping the documentation there in case people are still using them.

Reference
@keywords internal which flags the topic as internal and removes from topic indexes. It’s useful because it removes the function from the documentation index; it’s useful for functions aimed primarily at other developers, not typical users of the package.
https://roxygen2.r-lib.org/articles/index-crossref.html#search

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants