Fix custom format and transport examples in customization guide #27

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

Goal

Correct the custom transport example and show how custom formats and transports can be configured globally.

Scope

  • Make the transport example self-contained and valid against FeedReader.Transport.request/2 and its response map contract; do not rely on an undefined MyHTTPClient.get/1 API.
  • Add application-config examples for custom :formats, :http_client, and transport-specific options.
  • Show that call-level options override configured values, and retain a per-call usage example where useful.
  • Review the guide for consistency with the complete option reference.

Acceptance

  • Example code uses the actual callback and response contract and is internally consistent.
  • Keep this docs PR below 150 changed lines, counting additions and deletions.
## Goal Correct the custom transport example and show how custom formats and transports can be configured globally. ## Scope - Make the transport example self-contained and valid against `FeedReader.Transport.request/2` and its response map contract; do not rely on an undefined `MyHTTPClient.get/1` API. - Add application-config examples for custom `:formats`, `:http_client`, and transport-specific options. - Show that call-level options override configured values, and retain a per-call usage example where useful. - Review the guide for consistency with the complete option reference. ## Acceptance - Example code uses the actual callback and response contract and is internally consistent. - Keep this docs PR below 150 changed lines, counting additions and deletions.
mmacia self-assigned this 2026-10-27 23:42:11 +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#27