Skip to content

Commit

Permalink
docs: move deprecation badge to top of doc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
szhorvat committed Jan 19, 2024
1 parent 2b26635 commit b19a7c2
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 11 deletions.
8 changes: 5 additions & 3 deletions R/centrality.R
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,10 @@ alpha.centrality <- function(graph, nodes = V(graph), alpha = 1, loops = FALSE,

#' Deprecated version of `betweenness()`
#'
#' @description Use [`betweenness()`] with the `cutoff` argument instead.
#' @description
#' `r lifecycle::badge("deprecated")`
#'
#' Use [`betweenness()`] with the `cutoff` argument instead.
#' @param vids The vertices for which the vertex betweenness estimation will be
#' calculated.
#' @inheritParams betweenness
Expand Down Expand Up @@ -342,9 +344,9 @@ edge_betweenness <- function(graph, e = E(graph),
#' Deprecated version of `edge_betweenness()`
#'
#' @description
#' Use [`edge_betweenness()`] with the `cutoff` argument instead.
#' `r lifecycle::badge("deprecated")`
#'
#' Use [`edge_betweenness()`] with the `cutoff` argument instead.
#' @inheritParams edge_betweenness
#' @keywords internal
#' @export
Expand Down Expand Up @@ -458,9 +460,9 @@ closeness <- function(graph, vids = V(graph),
#' Deprecated version of `closeness()`
#'
#' @description
#' Use [`closeness()`] with the `cutoff` argument instead.
#' `r lifecycle::badge("deprecated")`
#'
#' Use [`closeness()`] with the `cutoff` argument instead.
#' @inheritParams closeness
#' @keywords internal
#' @export
Expand Down
6 changes: 3 additions & 3 deletions man/centr_degree_tmax.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions man/centralization.degree.tmax.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/estimate_betweenness.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/estimate_closeness.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/estimate_edge_betweenness.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b19a7c2

Please sign in to comment.