Skip to content

Commit db206af

Browse files
Edit tinymist's module-level doc comment syntax
1 parent 6c66306 commit db206af

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

rfcs/0001-doctring-syntax.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,10 @@ Rust prefixes module-level doc comments with `//!`. The syntax of module-level d
213213

214214
[tinymist.](https://myriad-dreamin.github.io/tinymist/feature/docs.html)
215215

216-
- A doc comment can be started with either `///` or `//` and the comments with same prefix are grouped together as a a single docstring. This is a loosed syntax because of Issue 2: the syntax of doc comments is not yet decided.
217216
- The docstring is in typst syntax and a docstring can only access the public definitions provided by the current package, if it is in a package.
218217
- The valid places are limited to only before "Let bindings" and at the start of the "Modules" (Files), to ensure simple migration to official syntax in future.
218+
- A doc comment of let bindings can be started with either `///` or `//` and the comments with same prefix are grouped together as a a single docstring. This is a loosed syntax because of Issue 2: the syntax of doc comments is not yet decided.
219+
- A doc comment of modules can only start with `///`, because of Issue 2.3: normal comments can occur at the start of the file to include License information.
219220

220221
## Unresolved questions
221222

rfcs/0001-doctring-syntax.typ

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,9 +218,10 @@ Rust prefixes module-level doc comments with `//!`. The syntax of module-level d
218218

219219
#link("https://myriad-dreamin.github.io/tinymist/feature/docs.html")[tinymist.]
220220

221-
- A doc comment can be started with either `///` or `//` and the comments with same prefix are grouped together as a a single docstring. This is a loosed syntax because of Issue 2: the syntax of doc comments is not yet decided.
222221
- The docstring is in typst syntax and a docstring can only access the public definitions provided by the current package, if it is in a package.
223222
- The valid places are limited to only before "Let bindings" and at the start of the "Modules" (Files), to ensure simple migration to official syntax in future.
223+
- A doc comment of let bindings can be started with either `///` or `//` and the comments with same prefix are grouped together as a a single docstring. This is a loosed syntax because of Issue 2: the syntax of doc comments is not yet decided.
224+
- A doc comment of modules can only start with `///`, because of Issue 2.3: normal comments can occur at the start of the file to include License information.
224225

225226
= Unresolved questions
226227

0 commit comments

Comments
 (0)