Document that wildcard matching excludes some directories

[bradleyfalzon]

I noticed one of my directories was being excluded when I didn't expect it to. The tool excludes testdata, as well as directories beginning with dot or underscore when recursively matching.

This is expected behaviour, but it wasn't documented publicly, this change adds those docs according to the behaviour in https://github.com/kisielk/gotool/blob/master/match.go#L91-L95.

I'm not convinced on the wording, so happy for this to be closed for another approach.

Thanks for the tool.

[dmitshur]

One correction. This doesn't affect only wildcard (typo in that word), but also others. E.g., it affects "all".

Maybe just drop the "using wildcards" part?

[bradleyfalzon]

Agreed on all accounts, but if we drop the wording of wildcards, would someone think a path of ./testdata would be excluded (it wouldn't be)?

Perhaps "when recursively matching" or "when matching multiple packages"?

// When matching recursively, directories are ignored if they are prefixed with a
// dot or an underscore (such as ".foo" or "_foo"), or are named "testdata".

[bradleyfalzon]

I've updated the push to reflect this, but still happy to make further changes.

[dmitshur]

This is expected behaviour, but it wasn't documented publicly, this change adds those docs according to the behaviour in https://github.com/kisielk/gotool/blob/master/match.go#L91-L95.

For posterity, this is indeed expected, and it's documented in cmd/go:

But it should be nice to document it as part of gotool API as well, I think.

[dmitshur]

This wording LGTM, thanks for updating @bradleyfalzon.

[dmitshur]

Friendly ping @kisielk or @dominikh, can you review and merge this?

[kisielk]

Thanks for the ping, I was on vacation when this was filed / discussed :)