Review streaming and results guides for configured defaults #28

Open
opened 2026-10-27 23:41:35 +00:00 by mmacia · 0 comments
Owner

Goal

Update the remaining parsing guides so their examples and option statements agree with app-configured defaults.

Scope

  • Review guides/streaming.md, guides/results.md, and guides/xml-recovery.md.
  • Update parse_stream/2 and verified parsing examples or statements where configuration changes whether an option must be supplied.
  • Keep examples that demonstrate per-call options where useful, and link to the central configuration/default reference.

Acceptance

  • No stale claim says :max_items must always be present in the call.
  • Defaults and examples are consistent with the API reference.
  • Keep this docs PR below 150 changed lines, counting additions and deletions.
## Goal Update the remaining parsing guides so their examples and option statements agree with app-configured defaults. ## Scope - Review `guides/streaming.md`, `guides/results.md`, and `guides/xml-recovery.md`. - Update `parse_stream/2` and verified parsing examples or statements where configuration changes whether an option must be supplied. - Keep examples that demonstrate per-call options where useful, and link to the central configuration/default reference. ## Acceptance - No stale claim says `:max_items` must always be present in the call. - Defaults and examples are consistent with the API reference. - Keep this docs PR below 150 changed lines, counting additions and deletions.
mmacia self-assigned this 2026-10-27 23:42:12 +00:00
Sign in to join this conversation.
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: mmacia/feed_reader#28