haskell / haskell/cabal

Missing documentation of conditionals?

Open
#7,389 4 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/check documentation
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

I couldn't find any mention of conditionals (`if`) in the [doc index](https://cabal.readthedocs.io/en/3.4/genindex.html), nor could I get help on possible values of the `os` predicate.

[`cabal check` alerts me that none of my tries works: `Warning: Unknown operating system name 'macosx', 'mac', 'macos'`]

Contributor guide

Open the contributing guide

Research direction

Start with the Cabal documentation index and the behavior reported by `cabal check`. Determine where conditional expressions and the `os` predicate are documented, then document the supported operating-system values and conditional syntax. Done means the relevant documentation is discoverable from the index and matches the values accepted by `cabal check`.

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.