bitemyapp / bitemyapp/esqueleto

Incorrect documentation of "mode" parameter

Open
#179 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
399
Forks
107
Avg merge
1d 17h
Merged PRs (30d)
1

Description

It looks like all of the render query functions mention a `mode` parameter, but only `renderQueryToText` takes one

![image](https://user-images.githubusercontent.com/1274145/77771533-08eab100-7004-11ea-9667-e14ead694ff2.png)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the documentation for the render query functions and compare the parameter lists shown for each function. Correct the references to the `mode` parameter so they match the functions' actual signatures, then review the affected documentation to confirm the descriptions are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.