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 documentation for lifecycle badge placement #398

Closed
bailliem opened this issue Jun 9, 2022 · 0 comments · Fixed by #409
Closed

Review documentation for lifecycle badge placement #398

bailliem opened this issue Jun 9, 2022 · 0 comments · Fixed by #409
Assignees
Labels
documentation Improvements or additions to documentation issue Used for project filtering
Milestone

Comments

@bailliem
Copy link
Collaborator

bailliem commented Jun 9, 2022

Step 1: review list of experimental functions where API may change.
Step 2: Review documentation of those functions to ensure lifecycle badge is placed in the @description block. See https://cran.r-project.org/web/packages/lifecycle/vignettes/communicate.html
e.g.

#' Add two numbers
#'
#' @description
#' r lifecycle::badge("experimental")
#'
#' This function was deprecated because we realised that it's
#' a special case of the [sum()] function.

Step 3: add experimental back to main package to reflect possible changes to API

@bailliem bailliem added the issue Used for project filtering label Jun 9, 2022
@bailliem bailliem added this to the v0.3.0 milestone Jun 9, 2022
@bailliem bailliem self-assigned this Jun 9, 2022
@bailliem bailliem added the documentation Improvements or additions to documentation label Jun 9, 2022
@ddsjoberg ddsjoberg mentioned this issue Jun 13, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation issue Used for project filtering
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant