Skip to content

Commit d04f940

Browse files
authored
Inject rust language into documentation comments when the language is not specified (#13116)
1 parent 691c9bd commit d04f940

File tree

5 files changed

+27
-1
lines changed

5 files changed

+27
-1
lines changed

book/src/generated/lang-support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@
138138
| make || || |
139139
| markdoc || | | `markdoc-ls` |
140140
| markdown || | | `marksman`, `markdown-oxide` |
141+
| markdown-rustdoc || | | |
141142
| markdown.inline || | | |
142143
| matlab |||| |
143144
| mermaid || | | |

languages.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1704,6 +1704,15 @@ block-comment-tokens = { start = "<!--", end = "-->" }
17041704
name = "markdown"
17051705
source = { git = "https://github.com/tree-sitter-grammars/tree-sitter-markdown", rev = "62516e8c78380e3b51d5b55727995d2c511436d8", subpath = "tree-sitter-markdown" }
17061706

1707+
[[language]]
1708+
name = "markdown-rustdoc"
1709+
scope = "source.markdown-rustdoc"
1710+
grammar = "markdown"
1711+
injection-regex = "markdown-rustdoc"
1712+
file-types = []
1713+
indent = { tab-width = 2, unit = " " }
1714+
block-comment-tokens = { start = "<!--", end = "-->" }
1715+
17071716
[[language]]
17081717
name = "markdown.inline"
17091718
scope = "source.markdown.inline"
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
; inherits: markdown
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; inherits: markdown
2+
3+
; In Rust, it is common to have documentation code blocks not specify the
4+
; language, and it is assumed to be Rust if it is not specified.
5+
6+
(fenced_code_block
7+
(code_fence_content) @injection.content
8+
(#set! injection.language "rust")
9+
(#set! injection.include-unnamed-children))
10+
11+
(fenced_code_block
12+
(info_string
13+
(language) @injection.language)
14+
(code_fence_content) @injection.content (#set! injection.include-unnamed-children))
15+

runtime/queries/rust/injections.scm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
(#set! injection.language "comment"))
33

44
((doc_comment) @injection.content
5-
(#set! injection.language "markdown")
5+
(#set! injection.language "markdown-rustdoc")
66
(#set! injection.combined))
77

88
((macro_invocation

0 commit comments

Comments
 (0)