Skip to content

Commit 500a6bf

Browse files
committed
refactor!: rename to sep id_view_col
different ids, less confusing
1 parent 9d653fa commit 500a6bf

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

R/nocodb.gen.R

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1994,7 +1994,7 @@ delete_tbl <- function(id_tbl,
19941994
#'
19951995
#' @inheritParams tbl
19961996
#' @param order `r pkgsnip::type("int", 1L)`
1997-
#' A number to assign as the table's NocoDB-specific order "weight".
1997+
#' A number to assign as the table's UI order "weight".
19981998
#'
19991999
#' @return `id_tbl`, invisibly.
20002000
#' @family tbls
@@ -2301,18 +2301,18 @@ tbl_view_col_id <- function(id_tbl,
23012301
#' Update NocoDB table view column
23022302
#'
23032303
#' Updates the metadata of the specified table view column on a NocoDB server via its
2304-
#' `PATCH /api/v2/meta/views/{id_view}/columns/{id_col}` API endpoint.
2304+
#' `PATCH /api/v2/meta/views/{id_view}/columns/{id_view_col}` API endpoint.
23052305
#'
23062306
#' @inheritParams tbl_view_cols
2307-
#' @param id_col `r pkgsnip::type("chr", 1L)`
2307+
#' @param id_view_col `r pkgsnip::type("chr", 1L)`
23082308
#' NocoDB table view column identifier as returned by [tbl_view_col_id()].
23092309
#' @param show `r pkgsnip::type("lgl", 1L)`
23102310
#' Whether or not to show the column in the specified view. Omitted if `NULL`.
23112311
#'
2312-
#' @return `id_col`, invisibly.
2312+
#' @return `id_view_col`, invisibly.
23132313
#' @family views
23142314
#' @export
2315-
update_tbl_view_col <- function(id_col,
2315+
update_tbl_view_col <- function(id_view_col,
23162316
id_view,
23172317
show = NULL,
23182318
origin = funky::config_val("origin"),
@@ -2324,15 +2324,15 @@ update_tbl_view_col <- function(id_col,
23242324
checkmate::assert_flag(show,
23252325
null.ok = TRUE)
23262326

2327-
api(path = glue::glue("api/v2/meta/views/{id_view}/columns/{id_col}"),
2327+
api(path = glue::glue("api/v2/meta/views/{id_view}/columns/{id_view_col}"),
23282328
method = "PATCH",
23292329
origin = origin,
23302330
email = email,
23312331
password = password,
23322332
api_token = api_token,
23332333
body_json = purrr::compact(list(show = show)))
23342334

2335-
invisible(id_col)
2335+
invisible(id_view_col)
23362336
}
23372337

23382338
#' List NocoDB table columns

Rmd/nocodb.Rmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2378,7 +2378,7 @@ NOTES:
23782378
#'
23792379
#' @inheritParams tbl
23802380
#' @param order `r pkgsnip::type("int", 1L)`
2381-
#' A number to assign as the table's NocoDB-specific order "weight".
2381+
#' A number to assign as the table's UI order "weight".
23822382
#'
23832383
#' @return `id_tbl`, invisibly.
23842384
#' @family tbls
@@ -2719,18 +2719,18 @@ NOTES:
27192719
#' Update NocoDB table view column
27202720
#'
27212721
#' Updates the metadata of the specified table view column on a NocoDB server via its
2722-
#' `PATCH /api/v2/meta/views/{id_view}/columns/{id_col}` API endpoint.
2722+
#' `PATCH /api/v2/meta/views/{id_view}/columns/{id_view_col}` API endpoint.
27232723
#'
27242724
#' @inheritParams tbl_view_cols
2725-
#' @param id_col `r pkgsnip::type("chr", 1L)`
2725+
#' @param id_view_col `r pkgsnip::type("chr", 1L)`
27262726
#' NocoDB table view column identifier as returned by [tbl_view_col_id()].
27272727
#' @param show `r pkgsnip::type("lgl", 1L)`
27282728
#' Whether or not to show the column in the specified view. Omitted if `NULL`.
27292729
#'
2730-
#' @return `id_col`, invisibly.
2730+
#' @return `id_view_col`, invisibly.
27312731
#' @family views
27322732
#' @export
2733-
update_tbl_view_col <- function(id_col,
2733+
update_tbl_view_col <- function(id_view_col,
27342734
id_view,
27352735
show = NULL,
27362736
origin = funky::config_val("origin"),
@@ -2742,15 +2742,15 @@ update_tbl_view_col <- function(id_col,
27422742
checkmate::assert_flag(show,
27432743
null.ok = TRUE)
27442744
2745-
api(path = glue::glue("api/v2/meta/views/{id_view}/columns/{id_col}"),
2745+
api(path = glue::glue("api/v2/meta/views/{id_view}/columns/{id_view_col}"),
27462746
method = "PATCH",
27472747
origin = origin,
27482748
email = email,
27492749
password = password,
27502750
api_token = api_token,
27512751
body_json = purrr::compact(list(show = show)))
27522752
2753-
invisible(id_col)
2753+
invisible(id_view_col)
27542754
}
27552755
```
27562756

man/create_data_src_tbl.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/create_tbl.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/reorder_tbl.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/update_tbl_view_col.Rd

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)