aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/style.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/style.md')
-rw-r--r--docs/dev/style.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md
index 67cbc6744..7481f8008 100644
--- a/docs/dev/style.md
+++ b/docs/dev/style.md
@@ -643,6 +643,27 @@ assert!(x >= lo && x <= hi>);
643**Rationale:** Less-then comparisons are more intuitive, they correspond spatially to [real line](https://en.wikipedia.org/wiki/Real_line). 643**Rationale:** Less-then comparisons are more intuitive, they correspond spatially to [real line](https://en.wikipedia.org/wiki/Real_line).
644 644
645 645
646## Token names
647
648Use `T![foo]` instead of `SyntaxKind::FOO_KW`.
649
650```rust
651// GOOD
652match p.current() {
653 T![true] | T![false] => true,
654 _ => false,
655}
656
657// BAD
658
659match p.current() {
660 SyntaxKind::TRUE_KW | SyntaxKind::FALSE_KW => true,
661 _ => false,
662}
663```
664
665**Rationale:** The macro uses the familiar Rust syntax, avoiding ambiguities like "is this a brace or bracket?".
666
646## Documentation 667## Documentation
647 668
648For `.md` and `.adoc` files, prefer a sentence-per-line format, don't wrap lines. 669For `.md` and `.adoc` files, prefer a sentence-per-line format, don't wrap lines.