Skip to content

Commit

Permalink
as_qgis_argument() docs: add Value section *
Browse files Browse the repository at this point in the history
Relates to CRAN review: #167 (comment).
  • Loading branch information
florisvdh committed Aug 7, 2023
1 parent 1a9e1d2 commit 66214eb
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
15 changes: 15 additions & 0 deletions R/qgis-arguments.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@
#' @param .use_json_input,use_json_input TRUE if the arguments will be
#' serialized as JSON instead of serialized as a command-line argument.
#'
#' @returns
#' The returned object class and form depends on the class and form of `x` and
#' on the targeted `qgis_type`.
#'
#' If `x` is a `qgis_list_input` or a `qgis_dict_input` object, the same class
#' is returned but with `as_qgis_argument()` applied to each element.
#'
#' In all other cases, the outcome can depend on the value of `use_json_input`
#' and this also holds for the elements of `qgis_list_input` and
#' `qgis_dict_input` objects:
#'
#' - if `use_json_input = FALSE`: a string.
#' - if `use_json_input = TRUE`: various classes can be returned that will be
#' correctly serialized as JSON.
#'
#' @examplesIf has_qgis()
#' qgisprocess:::as_qgis_argument(
#' c("a", "b"),
Expand Down
16 changes: 16 additions & 0 deletions man/as_qgis_argument.Rd

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

0 comments on commit 66214eb

Please sign in to comment.