Skip to content

chore!: remove deprecated neimode parameter from bfs() and dfs() #1526

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.

Sign up for GitHub

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

Merged
krlmlr merged 4 commits into from
Jan 9, 2025
Merged

chore!: remove deprecated neimode parameter from bfs() and dfs() #1526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c9d6bd
chore!: remove deprecated `neimode` parameter from `bfs` / `dfs`; ori…
maelle Sep 24, 2024
6ea56f8
Results
krlmlr Nov 7, 2024
0af3b31
Merge branch 'main' into neimode
krlmlr Nov 28, 2024
8731373
Merge branch 'main' into neimode
krlmlr Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions R/structural.properties.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2140,14 +2140,11 @@ bfs <- function(
ensure_igraph(graph)

if (lifecycle::is_present(neimode)) {
lifecycle::deprecate_warn(
lifecycle::deprecate_stop(
"1.3.0",
"bfs(neimode)",
"bfs(mode)"
)
if (missing(mode)) {
mode <- neimode
}
}

if (length(root) == 1) {
Expand Down Expand Up @@ -2315,14 +2312,11 @@ dfs <- function(graph, root, mode = c("out", "in", "all", "total"),
rho = parent.frame(), neimode = deprecated()) {
ensure_igraph(graph)
if (lifecycle::is_present(neimode)) {
lifecycle::deprecate_warn(
lifecycle::deprecate_stop(
"1.3.0",
"dfs(neimode)",
"dfs(mode)"
)
if (missing(mode)) {
mode <- neimode
}
}

root <- as_igraph_vs(graph, root) - 1
Expand Down
8 changes: 4 additions & 4 deletions tests/testthat/_snaps/structural.properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Code
d <- dfs(g, root = 2, unreachable = FALSE, neimode = "out")
Condition
Warning:
The `neimode` argument of `dfs()` is deprecated as of igraph 1.3.0.
Error:
! The `neimode` argument of `dfs()` was deprecated in igraph 1.3.0 and is now defunct.
i Please use the `mode` argument instead.

---
Expand All @@ -13,8 +13,8 @@
b <- bfs(g, root = 2, neimode = "out", unreachable = FALSE, order = TRUE, rank = TRUE,
father = TRUE, pred = TRUE, succ = TRUE, dist = TRUE)
Condition
Warning:
The `neimode` argument of `bfs()` is deprecated as of igraph 1.3.0.
Error:
! The `neimode` argument of `bfs()` was deprecated in igraph 1.3.0 and is now defunct.
i Please use the `mode` argument instead.

# bfs() works
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/test-structural.properties.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ test_that("dfs() does not pad order", {
test_that("bfs() deprecated argument", {
g <- make_star(3)

expect_snapshot({
expect_snapshot(error = TRUE, {
d <- dfs(
g,
root = 2,
Expand Down Expand Up @@ -199,7 +199,7 @@ test_that("bfs() works", {
test_that("bfs() deprecated argument", {
g <- graph_from_literal(a - +b - +c, z - +a, d)

expect_snapshot({
expect_snapshot(error = TRUE, {
b <- bfs(
g,
root = 2,
Expand Down