[all-commits] [llvm/llvm-project] 5b8617: Clarifying the documentation for diagnostic format...

Aaron Ballman via All-commits all-commits at lists.llvm.org
Wed Aug 31 05:33:18 PDT 2022


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 5b861743539aa9a1184589647f6e9ce96da8b620
      https://github.com/llvm/llvm-project/commit/5b861743539aa9a1184589647f6e9ce96da8b620
  Author: Aaron Ballman <aaron at aaronballman.com>
  Date:   2022-08-31 (Wed, 31 Aug 2022)

  Changed paths:
    M clang/docs/InternalsManual.rst

  Log Message:
  -----------
  Clarifying the documentation for diagnostic formats; NFC

While discussing diagnostic format strings with a GSoC mentee, it
became clear there was some confusion regarding how to use them.
Specifically, the documentation for %select caused confunsion because
it was using %select{}2 and talking about how the integer value must
be in the range [0..2], which made it seem like the positional argument
was actually specifying the range of acceptable values.

I clarified several of the examples similarly, moved some documentation
to a more appropriate place, and added some additional information to
the %s modifier to point out that %plural exists.




More information about the All-commits mailing list