Documentation around bats-mock could be improved

[liamstevens]

Hey team,

Raising this as I spent quite a while yesterday scratching my head over my stubs not behaving the way that I would have expected them to, based on both internal and external docs. Specifically this relates to the use of *, and the fact that it only matches one arg in the pattern. I know this isn't actually explicitly called out in the original repository's documentation, either.

I can see that this was brought up in a separate issue with a corresponding PR, but something a little clearer than this or with examples of usage of multiple * would be good. There's also some instances of these being escaped in the README, which doesn't appear to matter based on my testing.

It would be useful, I feel, to add a section to the BK Documentation around testing plugins that covers this. It would have saved me a lot of time and headache.

[mcncl]

@liamstevens thanks for raising this. We definitely want the experience of contributing to be as smooth as possible. We'll take a look in to how we can best document this 🙂