Update README and parsing examples for configured defaults #29

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

Goal

Make the primary README and parsing-usage examples reflect application-configured defaults.

Scope

  • Review and update the quick start and parsing examples in README.md and guides/usage.md.
  • Show configured :max_items and at least one per-call override.
  • Update wording that says collection always requires an explicit call option; it remains required only when absent from both call options and config.

Acceptance

  • Examples remain consistent with the documented config namespace and precedence.
  • Keep this docs PR below 150 changed lines, counting additions and deletions.
## Goal Make the primary README and parsing-usage examples reflect application-configured defaults. ## Scope - Review and update the quick start and parsing examples in `README.md` and `guides/usage.md`. - Show configured `:max_items` and at least one per-call override. - Update wording that says collection always requires an explicit call option; it remains required only when absent from both call options and config. ## Acceptance - Examples remain consistent with the documented config namespace and precedence. - 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#29