Docs: [require-await] document behavior around generator functions #9769
Description
Before You File a Documentation Request Please Confirm You Have Done The Following...
- I have looked for existing open or closed documentation requests that match my proposal.
- I have read the FAQ and my problem is not listed.
Suggested Changes
The base rule explicitly mentions that it does not flag on generators.
Our rule intentionally departs from that behavior. However, we don't say so in the docs, so, it's surprising when you encounter a require-await error in a generator function. Let's document this!