Commit 46f1f17
committed
Document buoy error_reason/0 in README
A2 standardization shipped error_reason/0 as an exported sum in
0.2.8 but the README didn't enumerate it. Added an 'Errors' section
between the Pool Options table and Telemetry listing the 9 atoms:
- pool_not_started, buoy_not_started, pool_already_started,
invalid_url (buoy-level)
- invalid_headers, invalid_chunk_size (HTTP parser via
buoy_protocol's handle_data path)
- no_server, shackle_not_started, timeout (shackle, propagated)
Plus a brief note on why error/0 itself stays loose despite
error_reason being a closed sum: buoy_client:responses/5 has a
{error, not_enough_data} buffering branch that's required at
runtime but unreachable from dialyzer when error/0 is tight.
error_reason/0 covers the docs goal without the false-positive
cost. Full rationale lives in include/buoy.hrl.
The 0.2.9 tag (the latest from this session) moves forward to
include the README updates.1 parent 1f69430 commit 46f1f17
1 file changed
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
117 | 127 | | |
118 | 128 | | |
119 | 129 | | |
| |||
0 commit comments