tweag / tweag/rules_haskell

haskell_doc should accept custom haddock_flags

Open
#583 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue P3 type: feature request
Dominant language
Starlark
Stars
279
Forks
93
Avg merge
13d 11h
Merged PRs (30d)
3

Description

This is a reopen of #425 to enhance haskell_doc in two ways:

  • haskell_doc should accept a custom list of haddock_flags. For now, haddock_flags can only be overridden in haskell_toolchain.
  • haskell_doc should be composable so that haskell_doc can take other documentation rule as deps argument.

Custom list of haddock flags for haskell toolchain is a complex implementation (see #425) for the discussion.

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

Start by reading the reopened issue #425 and the existing haskell_doc and haskell_toolchain rule entry points. Trace how haddock_flags are currently overridden and how documentation dependencies are represented. Done means haskell_doc accepts its own flags and can compose with another documentation rule through deps, with the required behavior agreed and covered by the project’s tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.