haskell / haskell/cabal

Haddockumentation of `Distribution.FieldGrammar.Class` out of sync with code

Open
#7,996 0 comments 0 reactions 0 assignees View on GitHub
documentation re: code quality type: bug
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

The doc mentions parameters `s` and `a`, but the new parameters are `c` and `g` (and likely have other roles).
https://github.com/haskell/cabal/blob/9a104a99c50e451731d9650e6c0f50721d7d1ce1/Cabal-syntax/src/Distribution/FieldGrammar/Class.hs#L30-L42

Broken by 920d6a98ebae2a12e9af1733e27c69e0becb4547.
@phadej, what would the updated doc be?

(Context: migrating `hackage-server` to Cabal 3.4.)

Contributor guide

Open the contributing guide

Research direction

Open Cabal-syntax/src/Distribution/FieldGrammar/Class.hs around lines 30–42 and compare the Haddock parameter documentation with the current declarations. Update the documentation to describe c and g and their roles accurately; done means the parameter names and descriptions match the code.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.