Re: [PATCH] Documentation: Fix minor grammatical and formatting issues

On Tue, 22 Apr 2025 at 08:53, Noboru Saito <noborusai(at)gmail(dot)com> wrote:
> Regarding "to to" and "that that", I agree that they might be
> technically acceptable.
> However, I personally find them a bit harder to parse and they
> increase the chance of misreading for me.
> Your suggested alternative for "to to" is much clearer!
>
> Ultimately, if leaving them as-is is perfectly fine, I'm happy to
> defer to your judgment.
> But I would certainly welcome the improvement if you decide to revise
> those phrases.

I've pushed all your suggestions aside from the toto.diff and thatthat.diff.

I noticed your tagmiss.diff was moving things in the wrong direction.
After looking at usages of <symbol>, we seem to use that for
preprocessor #defines. The following shows we're more consistent with
using <symbol> for these:

$ git grep -F "<symbol>BLCKSZ</symbol>" | wc -l
26

$ git grep -F "<literal>BLCKSZ</literal>" | wc -l
1

There's probably a bigger project there for anyone who feels strongly
enough about this and wants to harvest our list of #defines and check
how we reference those in the docs. I resisted fixing that one as it's
probably the tip of the iceberg.

Please see the attached patch which aims to improve the "to to"
instances (also a compiled .html for ease of review).

Does anyone have any opinion on the wording I'm proposing in the attached?

David