Document how to configure FeedReader defaults and provide a complete reference for option defaults.
Scope
Add a config :feed_reader, :options, [...] example and explain call-option > application config > existing default precedence.
Update the FeedReader and FeedReader.Transport API docs and the resource-limits guide.
Inventory public options, indicating defaults, derived defaults, required values, per-call-only options, and extension-owned transport options.
Preserve current behavior: :max_items has no built-in default, :formats defaults to an empty custom-format list, and :max_queue_bytes defaults to :max_item_bytes.
Document validation and invalid-value behavior where it differs by option.
Acceptance
The config keys and every documented default match implementation.
Keep this docs PR below 150 changed lines, counting additions and deletions.
## Goal
Document how to configure FeedReader defaults and provide a complete reference for option defaults.
## Scope
- Add a `config :feed_reader, :options, [...]` example and explain call-option > application config > existing default precedence.
- Update the `FeedReader` and `FeedReader.Transport` API docs and the resource-limits guide.
- Inventory public options, indicating defaults, derived defaults, required values, per-call-only options, and extension-owned transport options.
- Preserve current behavior: `:max_items` has no built-in default, `:formats` defaults to an empty custom-format list, and `:max_queue_bytes` defaults to `:max_item_bytes`.
- Document validation and invalid-value behavior where it differs by option.
## Acceptance
- The config keys and every documented default match implementation.
- Keep this docs PR below 150 changed lines, counting additions and deletions.
mmacia
self-assigned this 2026-10-27 23:42:11 +00:00
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Goal
Document how to configure FeedReader defaults and provide a complete reference for option defaults.
Scope
config :feed_reader, :options, [...]example and explain call-option > application config > existing default precedence.FeedReaderandFeedReader.TransportAPI docs and the resource-limits guide.:max_itemshas no built-in default,:formatsdefaults to an empty custom-format list, and:max_queue_bytesdefaults to:max_item_bytes.Acceptance