If someone has time, it may be worth adding a small section to the "writing rules" about the report() function to give examples of how node, index and endIndex are likely used.

#8261

I've opened an issue for this and added some initial thoughts

I am a bit unsure about this change.

I agree with @romainmenke, word is sometimes OKish/convenient.
i.e. this PR is probably not necessary
If anything, it's line that will need a > [!WARNING] for its deprecation.

Should we keep the documentation as-is for now and await the outcome of #8261 ?

SGTM. Let's rework this PR for that issue.

I've reworked the docs based on @romainmenke excellent write-up in #8261 (comment).

I tried to give rule authors a sense of how the location arguments work without getting into overwhelming detail so that they have some grounding when they look at the code of existing rules.

I've given a couple of examples of what seem to be our most common patterns:

• using word
• using index and endIndex (often with a construct parser)

@ybiquitous Commit your suggestions. Thank you for your attention to detail.