haskell-servant/servant

Support API.Modifiers in servant-docs

Open

#902 opened on Feb 9, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
help wantedservant-docs

Description

I'm going to release servant-0.13 compatible suite without modifiers affecting the docs. I think they should, and it's not a big task!

Contributor guide

Tech stack
None
Domain
backendapidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
HaskellServant frameworkservant docs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding support for API.Modifiers in servant docs. First, locate the servant docs package source, likely in `servant docs/src/Servant/Docs.hs` or similar. Understand how modifiers are currently ignored and how other parts of servant (e.g., servant server) handle them. Check if there are any existing PRs or branches addressing this (none listed). Look for tests related to docs generation to see the expected output. The fix would involve modifying the document generation functions to include modifier effects.