Commit e62b4e2
committed
Document marina error_reason/0 and cql_error/0 in README
A2 standardization shipped both types as exports in 0.4.5, but the
README didn't enumerate them so callers had to peek at
include/marina.hrl to find the atoms. Added an 'Errors' subsection
under 'Usage' (alongside Query options) listing:
- marina_pool_not_started, timeout
- cql_error() = {pos_integer(), binary()} -- the server-side
CQL error code + message tuple, linked to Cassandra's CQL
error-codes documentation
- no_server, pool_not_started, shackle_not_started
Plus a one-liner that cql_error/0 is publicly exported for clean
pattern-matching at call sites.
The 0.4.6 tag (the latest from this session, on top of 0.4.5) moves
forward to this commit so the hex publish includes the README
updates. 0.4.5's commit stays where it is -- the README polish
lands at the newer tag.1 parent 7922c1d commit e62b4e2
1 file changed
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
118 | 128 | | |
119 | 129 | | |
120 | 130 | | |
| |||
0 commit comments