Azure / Azure/typespec-rust

Advertise into_pages() for pageable functions

Open
#959 0 comments 0 reactions 0 assignees View on GitHub
CodeGen rust
Dominant language
Rust
Stars
7
Forks
11
Avg merge
2d 5h
Merged PRs (30d)
5

Description

To better advertise that callers can iterate over pages and not just paged items, add documentation to the emitted functions like:

```rust
///
///
///
///
/// The returned `Pager` will iterate over items of type `T` by default.
/// To iterate over each page of type `P`, call `into_pages()` on the returned `Pager` before iterating any items.
```

Of course, replace `T` and `P` with the item type and page types, respectively.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.