search

haskell-nix / hnix

A Haskell re-implementation of the Nix expression language
https://hackage.haskell.org/package/hnix
BSD 3-Clause "New" or "Revised" License
754 stars 115 forks source link

Please, deduplicate the docs in `.travis.yml`, `build.sh`, `default.nix` #645

Closed Anton-Latukha closed 4 years ago

Anton-Latukha commented 4 years ago

I worked with files in the above order. And it seemed logical to provide the docs on every stage.

I agree with guys, restating docs three times is too verbose. Especially when it is done and .travis.yml relies on build.sh interface, which relies on default.nix interface, which relies on Haskel Lib.

I do not think slashing the docs completely is sane, since people who do not know Nixpkgs should be guided simply and intuitively. And we can not point to the Haskel Lib directly, the functionality of it is simplified in default.nix, many wrappers of Lib turned into simple boolean switches in default.nix header, and Nixpkgs docs there are bigger or sometimes not existent, more assuming and sometimes more obscure, then simply stating/explaining. So I think living the explanations in default.nix and make pointers to it is a sufficiently elegant solution.

Anton-Latukha commented 4 years ago

All this work does not go in vain, since during all this rehashing and rewriting the documentation and code always simplifies and improves a bit, which is important point we aim for to release this to make #637.