Skip to content

Commit

Permalink
docs: update generic type name of TableIterator (#1905)
Browse files Browse the repository at this point in the history
Update the doc of `TableIterator`, the generic type was renamed in
#1701 but the doc was not updated
  • Loading branch information
SteveLauC authored Oct 9, 2024
1 parent 3ea09af commit c9e218b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pgrx/src/iter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ where
///
/// [`TableIterator`] is typically used as the return type of a `#[pg_extern]`-style function,
/// indicating that the function returns a table of named columns. [`TableIterator`] is
/// generic over `T`, but that `T` must be a Rust tuple containing one or more elements. They
/// generic over `Row`, but that `Row` must be a Rust tuple containing one or more elements. They
/// must also be "named" using pgrx's [`name!`][crate::name] macro. See the examples below.
///
/// It is a lightweight wrapper around an iterator, which you provide during construction. The
Expand Down

0 comments on commit c9e218b

Please sign in to comment.