docs: the behaviour examples name the backend kura selects - #171
Merged
Conversation
kura_driver and kura_pool documented themselves in terms of pgo: the canonical impl, the conn a caller gets, the example that starts a pool. kura_backend_postgres selects minato now and kura's own tests carry no pgo at all, so the examples were describing a backend the reader will not get unless they ask for it. The pgo driver is still shipped by kura_postgres and still named where it differs, which is the transaction options and the shape of a checked out connection.
🟢 Code Coverage — 92.4%2612 of 2826 lines covered. 🟡 ELP Lint — 1 warning4 diagnostics found. See job logs for details. ℹ️ 11 OTP CVEs auto-ignored (already fixed in running version)These CVEs are patched in the installed OTP version but NVD data
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
kura_driverandkura_pooldocumented themselves in terms of pgo — the canonical impl, the conn a caller gets back, the example that starts a pool.kura_backend_postgresselects minato now and kura's own tests carry no pgo at all, so those examples described a backend the reader won't get unless they ask for it.The pgo driver is still shipped by kura_postgres and is still named where the two genuinely differ: transaction options, and the shape of a checked-out connection (minato hands back a process that owns it; pgo hands back its own conn record).
Docs only —
rebar3 ex_docwarning-free, tests unaffected.