Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ Config/Needs/website: tidyverse/tidytemplate
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Config/roxygen2/version: 8.0.0
4 changes: 2 additions & 2 deletions R/iterator-adapt.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
#' commit to the transducer approach. Feedback welcome._
#'
#' `iter_adapt()` takes an iterator `iter` and a list of
#' [Transformation steps][steps]. It returns an iterator that returns
#' transformation steps. It returns an iterator that returns
#' transformed values.
#'
#' `async_adapt()` does the same for async iterators, i.e. functions
#' that returns an awaitable value.
#'
#' @param iter An [iterator].
#' @param steps,... [Transformation steps][steps]. These dots are taken with
#' @param steps,... Transformation steps. These dots are taken with
#' implicit splicing of lists and passed to `compose()`.
#'
#' @seealso [loop()] for looping over iterator values with a `for`
Expand Down
10 changes: 5 additions & 5 deletions R/step-builder.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#'
#' `along_builder()` and `poke_into_builder()` are builder functions,
#' i.e. reducer functions that construct an output when reduced with
#' [purrr::reduce()] or [reduce_steps()]. While `along_builder()`
#' [purrr::reduce()] or `reduce_steps()`. While `along_builder()`
#' duplicates its input, `poke_into_builder()` fills the supplied
#' input in place. The latter is only meant for experience users as
#' this mutation can cause unexpected side effects. You should only
Expand All @@ -19,17 +19,17 @@
#' by vector growing and shrinking, supply a vector whose size matches
#' exactly the final output.
#'
#' The builder functions can be combined with [transformation
#' steps][steps] to provide interesting functionality. See the
#' [take()] variants for higher-level functions.
#' The builder functions can be combined with transformation
#' steps to provide interesting functionality. See the
#' `iter_take()` variants for higher-level functions.
#'
#' @param along A vector that will be safely duplicated before
#' filling.
#' @param to A vector that will be modified in place. If the final
#' output has a different length than `to`, it will still be copied
#' when grown and/or shrunk.
#'
#' @seealso [reduce_steps()], [steps]
#' @seealso `reduce_steps()`, transformation steps
#' @examples
#' # Let's discard all pair elements during reduction to make the
#' # examples a bit more interesting
Expand Down
6 changes: 3 additions & 3 deletions R/step-reduce.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
#' abstract and it takes some time understand how they work and how to
#' write one. However most of the time you shouldn't have to use
#' `reduce_steps()` or write your own transformation step. You will
#' typically use existing steps provided in coro (like [iter_map()]
#' and [iter_discard()]) with user-friendly wrappers such as
#' typically use existing steps provided in coro (like `iter_map()`
#' and `iter_discard()`) with user-friendly wrappers such as
#' `iter_adapt()`.
#'
#' `reduce_steps()` and thus all functions based on it support coro
Expand Down Expand Up @@ -120,7 +120,7 @@
#' builder function is called without argument to get an initial
#' value.
#'
#' @seealso [steps], [along_builder()]
#' @seealso transformation steps, `along_builder()`
#' @examples
#' # Let's create a chain of transformation. Let's start with the very
#' # last step, the builder function.
Expand Down
2 changes: 1 addition & 1 deletion R/step.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#' @description
#'
#' Transformation steps can be chained together to modify the
#' behaviour of an iterator (see [iter_adapt()]).
#' behaviour of an iterator (see `iter_adapt()`).
#'
#' * `iter_map()` applies a function `.f` over all inputs.
#'
Expand Down
5 changes: 5 additions & 0 deletions man/coro-package.Rd

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

Loading