Quotes psc-docs examples. - #1814

A side-note (asked in IRC): is the stack.yaml for this repo to have a null for the value extra-deps, instead of []? My copy of here Stack had a whinge until I made the edit myself.

It's odd, I've seen someone else say they need quotes for the globs to work too (in fact they don't work if I use single quotes, but do with double quotes), but I definitely do not on Windows or OSX. What platform/shell are you using?

$ bash --version
GNU bash, version 3.2.57(1)-release (x86_64-apple-darwin14)

(OS X, 10.10.5)

It requires quotes, because otherwise bash will try to expand the globs. Which just means you'll probably end up passing in an empty list of files.

The key seems to be what glob-expansion capabilities the shell has. Assume a directory structure that looks like:

abc/
  |-- file.purs
  '-- def/
        '-- file2.purs

Bash 3:

$ ls abc/**/*.purs
abc/def/file2.purs

Bash 4 and zsh have proper **-expansion (my assumption from reading docs; I have access to neither from here at the moment):

$ ls abc/**/*.purs
abc/file.purs
abc/def/file2.purs

In my particular example, purescript-prelude is a package with a src/Prelude.purs which isn't getting picked up when Bash 3 expands the **.

So the example in the current help text works by accident in some environments because some shells have proper expansion and some don't. When given to psc-docs as a quoted string, System.FilePath.Glob will always perform the ** expansion correctly.

Do double quotes work for you then? As single quoting the globs prevents them from working at all on Windows at least, although double quoting does still work.

Oh damn, I forgot about Windows again. Yes, double-quotes work; I've updated the branch to reflect this.

LGTM 👍

Thanks!