commercialhaskell / commercialhaskell/stack

Option naming should be more consistent

Open
#2,929 2 comments 1 reaction 0 assignees View on GitHub
component: docs (in-app) component: options parsing type: discuss
Dominant language
Haskell
Stars
4.1k
Forks
850
Avg merge
10h 37m
Merged PRs (30d)
4

Description

Motivated by [this SO question](http://stackoverflow.com/questions/41662105/usage-of-buildhaddock-arguments-option-of-stack-yaml) I just [updated](https://github.com/commercialhaskell/stack/commit/72186e79bf4bcf96308838b35be37531974eb13c) the documentation for the `build` options.

Here are a few inconsistencies that I noticed:

* In the yaml config we have `test-arguments`, `haddock-arguments` but `benchmark-opts`.

* We have `test` and `test-X`, `haddock` and `haddock-X`, but `bench` and `benchmark-X`.

* - `--test-arguments` -> `test-arguments: additional-args`
- `--haddock-arguments` -> `haddock-arguments: haddock-args`
- `--benchmark-arguments` -> `benchmark-opts: benchmark-arguments`

* `haddock-deps`, `open-haddocks` and `haddock-internal` should be inside the `haddock-arguments` block

* test `additional-args` and `haddock-arguments` each take a list of strings, while `benchmark-arguments` takes a single string (I didn't check the CLI)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.