#75 Revamping lifecycle docs

#' Deprecate functions and arguments
#'
#' @description
#'
#' These functions provide three levels of verbosity for deprecated
#' functions.
#' functions. Learn how to use them in `vignette("communicate")`.
#'
#' * `deprecate_soft()` warns only if the deprecated function is
#'   called from the global environment (so the user can change their
#'   script) or from the package currently being tested (so the
#'   package developer can fix the package). Use for soft-deprecated
#'   functions.
#'   called from the global environment or from the package currently
#'   being tested.
#'
#' * `deprecate_warn()` warns unconditionally. Use for deprecated functions.
#' * `deprecate_warn()` warns unconditionally.
#'
#' * `deprecate_stop()` fails unconditionally. Use for defunct functions.
#' * `deprecate_stop()` fails unconditionally.
#'
#' Warnings are only issued once every 8 hours to avoid overwhelming
#' the user. See the [verbosity option][verbosity] to control this
#' behaviour.
#' the user. Control with [`options(lifecycle_verbosity)`][verbosity].
#'
#' Deprecation warnings have class
#' `lifecycle_warning_deprecated`. Deprecation errors have class
#' `lifecycle_error_deprecated`.
#' @section Conditions:
#' * Deprecation warnings have class `lifecycle_warning_deprecated`.
#' * Deprecation errors have class `lifecycle_error_deprecated`.
#'
#' @param when A string giving the version when the behaviour was deprecated.
#' @param what A string describing what is deprecated:

@@ -4,42 +4,42 @@

#'
#' To include lifecycle badges in your documentation:
#'
#' 1. Call `usethis::use_lifecycle()` to import the badges in your
#'    package. They are copied in the `man/` folder.
#' 1. Call `usethis::use_lifecycle()` to copy the badge images into the
#'    `man/` folder of your package.
#'
#' 2. Call `lifecycle::badge()` inside R backticks to insert a
#'    lifecycle badge:
#'
#'     ```
#'     `r lifecycle::badge("experimental")`
#'     `r lifecycle::badge("deprecated")`
#'     #' `r lifecycle::badge("experimental")`
#'     #' `r lifecycle::badge("deprecated")`
#'     #' `r lifecycle::badge("superseded")`
#'     ```
#'
#'    If the deprecated feature is a function, a good place for this
#'    badge is at the top of the topic description. If it is an argument,
#'    you can put the badge in the argument description.
#'
#' The badge is displayed as image in the HTML version of the
#' The badge is displayed as an image in the HTML version of the
#' documentation and as text otherwise.
#'
#' `lifecycle::badge()` is ran by
#' roxygen at build time so you don't need to add lifecycle to your
#' `Imports:` section just to include a badge.
#' `lifecycle::badge()` is run by roxygen at build time so you don't need
#' to add lifecycle to `Imports:` just to use the badges. However, it's still
#' good practice to add to `Suggests:` so that it will be available to
#' package developers.
#'
#' @section Badges:
#' * `r lifecycle::badge("experimental")` `lifecycle::badge("experimental")`
#' * `r lifecycle::badge("stable")` `lifecycle::badge("stable")`
#' * `r lifecycle::badge("questioning")` `lifecycle::badge("questioning")`
#' * `r lifecycle::badge("superseded")` `lifecycle::badge("superseded")`
#' * `r lifecycle::badge("deprecated")` `lifecycle::badge("deprecated")`
#' * `r lifecycle::badge("defunct")` `lifecycle::badge("defunct")`
#'
#' The meaning of these badges is described in
#' `vignette("lifecycle")`.
#' The meaning of these stages is described in
#' `vignette("stages")`.
#'
#' @param stage A lifecycle stage as a string, one of:
#'   `"experimental"`, `"stable"`, `"questioning"`, `"superseded"`
#'   `"deprecated"`, `"defunct"`.
#' @param stage A lifecycle stage as a string. Must be one of
#'   `"experimental"`, `"stable"`, `"questioning"`, `"superseded"`, or
#'   `"deprecated"`.
#' @return An `Rd` expression describing the lifecycle stage.
#'
#' @export

@@ -122,8 +122,14 @@

}

spec_package <- function(env, signaller) {
  env <- topenv(env)

  # Hack for vignettes
  default <- getOption("lifecycle:::calling_package", NULL)
  if (!is.null(default)) {
    return(default)
  }

  env <- topenv(env)
  if (is_reference(env, global_env())) {
    # Convenient for experimenting interactively
    return("<NA>")

Everything is accounted for!

No changes detected that need to be reviewed.

What changes does Codecov check for?

Lines, not adjusted in diff, that have changed coverage data.

Files that introduced coverage data that had none before.

Files that have missing coverage data that once were tracked.

#75 b6a1d6f

Hiding 9 contexual commits

98.07% ø ø

Revert "Add quotes and comment one call out"

jennybc

#75 2672ab9

CI Passed

Hiding 1 contexual commits

98.07% ø ø

Add quotes and comment one call out

jennybc

#75 5fe0cc9

CI Passed

Hiding 1 contexual commits

98.07% ø ø

Edit "stages" vignette

jennybc

#75 7e4a6e9

CI Passed

Hiding 1 contexual commits

98.07% ø ø

Polishing manage vignette

hadley

#75 6432fe7

CI Passed

Hiding 1 contexual commits

98.07% ø ø

Update experimental with latest discussion results

#75 e0cb737

#75 9cf33d7

Hiding 1 contexual commits

98.01% ø ø

Still more writing

hadley

#75 1206970

CI Passed

Hiding 3 contexual commits

98.01% ø ø

Some more polishing

hadley

#75 9939940

CI Passed

Hiding 4 contexual commits

-29

+16

-45

82.14% ø ø

Add tibble to suggests

hadley

#75 8f788bb

CI Passed

Hiding 2 contexual commits

82.14% ø ø

Totally reorganise package development vignette

hadley

#75 487126c

CI Passed

Hiding 1 contexual commits

82.14% ø ø

Start on user vignette

hadley

#75 6f5c13d

CI Passed

Hiding 3 contexual commits

82.14% ø ø

Revamping lifecycle docs

hadley

#75 29e3118

CI Passed

+21

-24

+45

Pull Request Base Commit

98.07% 100.00% +0.06%

No longer require string what/with (#84)

hadley

2dfdd6e

CI Passed

Files		•	•	•	Coverage
R	+3	+2	ø	+1	^-0.36% 97.71%
Project Totals (10 files)	262	256	0	6	97.71%

122	122		}
123	123
124	124		spec_package <- function(env, signaller) {
125		-	env <- topenv(env)
126	125
	126	+	# Hack for vignettes
	127	+	default <- getOption("lifecycle:::calling_package", NULL)
	128	+	if (!is.null(default)) {
	129	+	return(default)
	130	+	}
	131	+
	132	+	env <- topenv(env)
127	133		if (is_reference(env, global_env())) {
128	134		# Convenient for experimenting interactively
129	135		return("<NA>")

Navigation	Overlay
`t` Navigate files	`h` Toggle hits
`y` Change url to tip of branch	`m` Toggle misses
`b / v` Jump to prev/next hit line	`p` Toggle partial
`z / x` Jump to prev/next missed or partial line	`1..9` Toggle flags
`shift + o` Open current page in GitHub	`a` Toggle all on
`/ or ?` Show keyboard shortcuts dialog	`c` Toggle context lines or commits

1	1		#' Deprecate functions and arguments
2	2		#'
3	3		#' @description
4		-	#'
5	4		#' These functions provide three levels of verbosity for deprecated
6		-	#' functions.
	5	+	#' functions. Learn how to use them in `vignette("communicate")`.
7	6		#'
8	7		#' * `deprecate_soft()` warns only if the deprecated function is
9		-	#' called from the global environment (so the user can change their
10		-	#' script) or from the package currently being tested (so the
11		-	#' package developer can fix the package). Use for soft-deprecated
12		-	#' functions.
	8	+	#' called from the global environment or from the package currently
	9	+	#' being tested.
13	10		#'
14		-	#' * `deprecate_warn()` warns unconditionally. Use for deprecated functions.
	11	+	#' * `deprecate_warn()` warns unconditionally.
15	12		#'
16		-	#' * `deprecate_stop()` fails unconditionally. Use for defunct functions.
	13	+	#' * `deprecate_stop()` fails unconditionally.
17	14		#'
18	15		#' Warnings are only issued once every 8 hours to avoid overwhelming
19		-	#' the user. See the [verbosity option][verbosity] to control this
20		-	#' behaviour.
	16	+	#' the user. Control with [`options(lifecycle_verbosity)`][verbosity].
21	17		#'
22		-	#' Deprecation warnings have class
23		-	#' `lifecycle_warning_deprecated`. Deprecation errors have class
24		-	#' `lifecycle_error_deprecated`.
	18	+	#' @section Conditions:
	19	+	#' * Deprecation warnings have class `lifecycle_warning_deprecated`.
	20	+	#' * Deprecation errors have class `lifecycle_error_deprecated`.
25	21		#'
26	22		#' @param when A string giving the version when the behaviour was deprecated.
27	23		#' @param what A string describing what is deprecated:

4	4		#'
5	5		#' To include lifecycle badges in your documentation:
6	6		#'
7		-	#' 1. Call `usethis::use_lifecycle()` to import the badges in your
8		-	#' package. They are copied in the `man/` folder.
	7	+	#' 1. Call `usethis::use_lifecycle()` to copy the badge images into the
	8	+	#' `man/` folder of your package.
9	9		#'
10	10		#' 2. Call `lifecycle::badge()` inside R backticks to insert a
11	11		#' lifecycle badge:
12	12		#'
13	13		#' ```
14		-	#' `r lifecycle::badge("experimental")`
15		-	#' `r lifecycle::badge("deprecated")`
	14	+	#' #' `r lifecycle::badge("experimental")`
	15	+	#' #' `r lifecycle::badge("deprecated")`
	16	+	#' #' `r lifecycle::badge("superseded")`
16	17		#' ```
17	18		#'
18	19		#' If the deprecated feature is a function, a good place for this
19	20		#' badge is at the top of the topic description. If it is an argument,
20	21		#' you can put the badge in the argument description.
21	22		#'
22		-	#' The badge is displayed as image in the HTML version of the
	23	+	#' The badge is displayed as an image in the HTML version of the
23	24		#' documentation and as text otherwise.
24	25		#'
25		-	#' `lifecycle::badge()` is ran by
26		-	#' roxygen at build time so you don't need to add lifecycle to your
27		-	#' `Imports:` section just to include a badge.
	26	+	#' `lifecycle::badge()` is run by roxygen at build time so you don't need
	27	+	#' to add lifecycle to `Imports:` just to use the badges. However, it's still
	28	+	#' good practice to add to `Suggests:` so that it will be available to
	29	+	#' package developers.
28	30		#'
29	31		#' @section Badges:
30	32		#' * `r lifecycle::badge("experimental")` `lifecycle::badge("experimental")`
31	33		#' * `r lifecycle::badge("stable")` `lifecycle::badge("stable")`
32		-	#' * `r lifecycle::badge("questioning")` `lifecycle::badge("questioning")`
33	34		#' * `r lifecycle::badge("superseded")` `lifecycle::badge("superseded")`
34	35		#' * `r lifecycle::badge("deprecated")` `lifecycle::badge("deprecated")`
35		-	#' * `r lifecycle::badge("defunct")` `lifecycle::badge("defunct")`
36	36		#'
37		-	#' The meaning of these badges is described in
38		-	#' `vignette("lifecycle")`.
	37	+	#' The meaning of these stages is described in
	38	+	#' `vignette("stages")`.
39	39		#'
40		-	#' @param stage A lifecycle stage as a string, one of:
41		-	#' `"experimental"`, `"stable"`, `"questioning"`, `"superseded"`
42		-	#' `"deprecated"`, `"defunct"`.
	40	+	#' @param stage A lifecycle stage as a string. Must be one of
	41	+	#' `"experimental"`, `"stable"`, `"questioning"`, `"superseded"`, or
	42	+	#' `"deprecated"`.
43	43		#' @return An `Rd` expression describing the lifecycle stage.
44	44		#'
45	45		#' @export

#75 Revamping lifecycle docs

No flags found

Everything is accounted for!

What changes does Codecov check for?

Show failed CI and contexual commits c 40 Commits

Show failed CI and contexual commits `c`

40 Commits