porsager / porsager/postgres

Readme `debug: true` inconsistency

Open
#928 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
8.7k
Forks
374
Avg merge
11d 16h
Merged PRs (30d)
1

Description

The readme currently has contradictory information where it states:

To log these it is required to specifically access error.query and error.parameters, or set debug: true in options.

Per the All Postgres options section however the value under the debug option should actually be a function (e.g. debug: console.log)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the README's statement about accessing error.query and error.parameters alongside the All Postgres options section's debug option. Update the contradictory wording so it accurately describes using a debug function such as debug: console.log, then check both sections for consistency.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, postgres
Domain
databases, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.