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

Lifecycle-badge definitions as they apply to functions #274

Open
maurolepore opened this issue Feb 13, 2019 · 4 comments
Open

Lifecycle-badge definitions as they apply to functions #274

maurolepore opened this issue Feb 13, 2019 · 4 comments

Comments

@maurolepore
Copy link

I see that lifecycle badges are increasingly used not only to refer to packages but also to functions within packages. But the definition of each stage remains focused on packages.

The solution may be as simple as replacing 'package' with 'package/function'. E.g.

We are no longer convinced that a questioning package/function is the optimal approach, but we don’t yet know what a better approach is.

@batpigandme
Copy link
Collaborator

These now exist in the lifecycle package. (See Getting started here). I would rather not maintain the definitions in two separate places, as that means we'd have to remember to update the tidyverse.org page if we change the wording in the lifecycle docs. But adding a link to the lifecycle definitions in the tidyverse page seems reasonable. (No need to PR, @maurolepore, as I'm working through the entire site over the next few weeks).

@hadley
Copy link
Member

hadley commented Apr 19, 2020

We might also consider adding a package lifecycle vignette to the lifecycle package so we can link both resources to the same place.

@jennybc
Copy link
Member

jennybc commented Jul 24, 2020

I'm staring at lifecycle stuff in usethis and believe we have now arrived at a situation where the lifecycle stages at https://www.tidyverse.org/lifecycle/ disagree with those at https://lifecycle.r-lib.org/articles/lifecycle.html (the "getting started" vignette of the lifecycle package). I'm going to align with the lifecycle package (?).

Agree:

  • experimental
  • maturing
  • stable
  • questioning
  • superseded

Disagree:

  • archived (only tidyverse.org)
  • dormant (only tidyverse.org)
  • soft-deprecated (only lifecycle)
  • deprecated (only lifecycle)
  • defunct (only lifecycle)

@batpigandme
Copy link
Collaborator

batpigandme commented Jul 27, 2020

FYI, if you're tying the diagram in in any way, I just opened a PR in lifecycle so that the box colours match up with the badges: r-lib/lifecycle#53

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

No branches or pull requests

4 participants