The comments provide new users (and sometimes even to experienced ones) a
handy reference. Though they might be a nuisance for someone who is more or
less familiar with the config syntax. I agree when you have just a few
relevant lines there and too many comments it becomes hard to find what you
are looking for. Unfortunately we have two conflicting goals here.

Some products (e.g. vagrant) use an explicit option to generate a clean
comment free config file to solve this problem. Experts can always choose
to use that option and we can still help the newbies with verbose comments.

-harendra


On 31 August 2016 at 00:32, Charles <[email protected]> wrote:

> Hi. I wonder if the stack.yaml generated from stack new could look like
> this:
>
>     # Documentation: https://docs.haskellstack.org/en/stable/
> yaml_configuration/
>     resolver: lts-6.14
>     packages:
>     - '.'
>     extra-deps: []
>     flags: {}
>     extra-package-dbs: []
>
> Perhaps all the comments would be better placed in the documentation
> rather than the file?
>
> --
> You received this message because you are subscribed to the Google Groups
> "haskell-stack" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To post to this group, send email to [email protected].
> To view this discussion on the web visit https://groups.google.com/d/
> msgid/haskell-stack/fb5b4d7c-c089-4f92-aa5b-a39ff081abab%
> 40googlegroups.com
> <https://groups.google.com/d/msgid/haskell-stack/fb5b4d7c-c089-4f92-aa5b-a39ff081abab%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
> For more options, visit https://groups.google.com/d/optout.
>

-- 
You received this message because you are subscribed to the Google Groups 
"haskell-stack" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/haskell-stack/CAPW%2BkkZfSDHwFhmHT%3DU_zLG9a8BkgeeoH%3D8wO%2BkifDdTo%2BSgPw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to