Strategy docs wrong?
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 175
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 9
Description
/**
* This strategy supports built-in Postgres types only, and does not need a database round-trip
* for initialization. This is the fastest strategy and is appropriate when you are not using
* any user-defined types (this includes enums).
*/
case object BuiltinsOnly extends Strategy
/**
* This strategy supports built-in Postgres types, as well as types that are defined in
* namespaces on the session search path. This is the default strategy.
*/
case object SearchPath extends Strategy
SearchPath indicates it's the default strategy but Session.pooled defaults to BuiltinsOnly. Is this comment incorrect?
Contributor guide
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 by locating the Strategy definitions and the Session.pooled entry point mentioned in the issue. Compare the documented default with the actual default used by Session.pooled, then update the relevant comment if they disagree and verify the surrounding documentation still matches the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgres, scala
- Domain
- databases
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100