Documentation uses nonfunctional "application_name" as an example connection parameter
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Gleam
- Stars
- 264
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
In the documentation (e.g. of `pog.connection_parameter`), "application_name" is used as an example parameter, but this parameter is always overridden by `pgo` with the value of `node()` (e.g. `nonode@nohost`), so this doesn't actually work.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation for `pog.connection_parameter` and inspect how the `application_name` example is presented. Verify the example against the issue's description of `pgo` overriding the parameter, then update the documentation so it shows a functional parameter or accurately explains the limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100