typelevel / typelevel/doobie

Typechecking documentation shows wrong .check output

Open
#976 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
2.2k
Forks
379
Avg merge
14m
Merged PRs (30d)
8

Description

The first query check (the one where there are issues) in

https://tpolecat.github.io/doobie/docs/06-Checking.html
(/modules/docs/src/main/tut/docs/06-Checking.md)

returns the same output as the second one (the one where issues are fixed).

Contributor guide

Open the contributing guide

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

Open /modules/docs/src/main/tut/docs/06-Checking.md and compare the first query-check example with the second one, then inspect the rendered Checking documentation. The first example should show the output for a query with issues, while the second should show the output after those issues are fixed.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.