Improve README with common questions on PGO #35
Merged
Conversation
This file contains 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
ghivert
force-pushed
the
docs/improve-readme
branch
from
5879c69
to
e1a7bcc
Compare
lpil
reviewed
Aug 26, 2024
README.md
Outdated
| Postgres ecosystem, `gleam_pgo` provides handling of | ||
| [connection URI as defined by Postgres](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS). Call `gleam/pgo.url_config` with your connection URI, | ||
| and in case it's correct against the Postgres standard, your `Config` will be | ||
| automatically generated! |
There was a problem hiding this comment.
Could you include an example of how this is done? Perhaps reading environment variables with envoy? It can be hard to tell what code to write from prose.
src/gleam/pgo.gleam
Outdated
| ip_version: IpVersion, | ||
| /// By default, PGO will return a n-tuple, in the order of the query. | ||
| /// (default: false) By default, PGO will return a n-tuple, in the order of the query. |
ghivert
force-pushed
the
docs/improve-readme
branch
from
e1a7bcc
to
dd71687
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi!
A small PR to complete the documentation to answer common questions on PGO!
I also suggest to close #8, and keep the fields as strings.
Hope it seems fine to you. 😄