Skip to content

Add examples #42

@jonthegeek

Description

@jonthegeek

Add examples to all exported functions. Find the list of exported functions in NAMESPACE.

Any function that hits the internet (iterate_with_json_cursor, req_perform_opinionated) should use @examplesIf httr2::is_online(). If the objects processed by a function is too complex to include in the example, usethis::use_data_raw("example_data") (if data-raw/example_data.R doesn't exist yet), prepare the dataset in data-raw/example_data.R, then usethis::use_data({ThisDatasetName}, overwrite = TRUE). Such datasets should be named example_{descriptive_name} in snake_case. Try to minimize example datasets and reuse an existing example dataset if possible. We will also need to document such datasets, with the instructions here: https://r-pkgs.org/data.html#sec-documenting-data

Metadata

Metadata

Labels

qcthat-nocov{qcthat}: Do not include in issue-test coverage reports

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions