encounter
/
dawn-cmake
mirror of https://github.com/encounter/dawn-cmake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Relax don't-quote-source rule 

Change-Id: Iab8412280f5c36a78ce7a972fe5304c14d2dc0bd
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/53808
Kokoro: Kokoro <noreply+kokoro@google.com>
Commit-Queue: Ben Clayton <bclayton@google.com>
Reviewed-by: David Neto <dneto@google.com>
This commit is contained in:
Ben Clayton 2021-06-09 07:48:38 +00:00 committed by Tint LUCI CQ
parent 4d4c1e58d2
commit 6a7a8b42e8
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/diagnostics_guide.md
View File

@ -36,26 +36,27 @@ This style matches the style found in most other compilers.
**Don't:** **Don't:**
``` ```
shader.wgsl:5:7 error: structure 'UBO' requires block decoration shader.wgsl:5:7 error: cannot multiply 'expr_a * expr_b' with types i32 and f32
struct UBO { var res : f32 = expr_a * expr_b
^^^ ^^^^^^^^^^^^^^^
``` ```
**Do:** **Do:**
``` ```
shader.wgsl:5:7 error: structure requires block decoration shader.wgsl:5:7 error: cannot multiply types i32 and f32
struct UBO { var res : f32 = expr_a * expr_b
^^^ ^^^^^^^^^^^^^^^
``` ```
**Justification:** **Justification:**
The highlighted line provides even more contextual information than the quoted The highlighted line provides even more contextual information than the quoted
source, and duplicating this information doesn't provide any more help to the source, and duplicating this information doesn't provide any more help to the
developer. developer. \
Quoting single word identifiers or keywords from the source is not discouraged.
## Use `note` diagnostics for providing additional links to relevant code ## Use `note` diagnostics for providing additional links to relevant code