docs: add warning about regexp global flag usage

[abhijit-hota]

See #220

[dougwilson]

Thank, but this allies to any JavaScript API that accepts a RegExp object and is not specific to this module.

[abhijit-hota]

@dougwilson I agree.

But this single line of documentation could have saved me (and most probably 5 others, based on the +1s on the issue) a lot of time and I would have never opened the issue in the first place.

I agree it applies to any JavaScript API but then again, it is just my opinion.

Of course, in the end it's your choice.

[dougwilson]

Hi @abhijit-hota I definately understand, but typically there is a base-level of knowledge required to read the docs of anything out there. We have to draw the line somewhere to keep the docs from getting out of control, as otherwise the docs would end up just being overwhelmed with notes about how JavaScript works throughout it. Please don't take this response as saying you are unfamiliar with JavaScript, only just stating where we draw the line for our docs: if it is about how JavaScript works (as is the case with this PR) then we don't add it to the docs. If it is something specific to how this module works, then of course we would add it.

[abhijit-hota]

@dougwilson I understand. Thank you for the response!