language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-07-07 21:15:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: mention tidy compatibility in docs.typ (#1841)
Some checks are pending
tinymist::ci / build-vscode-others (push) Blocked by required conditions
Details
tinymist::ci / publish-vscode (push) Blocked by required conditions
Details
tinymist::ci / Duplicate Actions Detection (push) Waiting to run
Details
tinymist::ci / Check Clippy, Formatting, Completion, Documentation, and Tests (Linux) (push) Waiting to run
Details
tinymist::ci / Check Minimum Rust version and Tests (Windows) (push) Waiting to run
Details
tinymist::ci / E2E Tests (darwin-arm64 on macos-latest) (push) Blocked by required conditions
Details
tinymist::ci / E2E Tests (linux-x64 on ubuntu-22.04) (push) Blocked by required conditions
Details
tinymist::ci / E2E Tests (linux-x64 on ubuntu-latest) (push) Blocked by required conditions
Details
tinymist::ci / E2E Tests (win32-x64 on windows-2019) (push) Blocked by required conditions
Details
tinymist::ci / E2E Tests (win32-x64 on windows-latest) (push) Blocked by required conditions
Details
tinymist::ci / prepare-build (push) Waiting to run
Details
tinymist::ci / build-binary (push) Blocked by required conditions
Details
tinymist::ci / build-vsc-assets (push) Blocked by required conditions
Details
tinymist::ci / build-vscode (push) Blocked by required conditions
Details
tinymist::gh_pages / build-gh-pages (push) Waiting to run
Details

Browse source
This commit is contained in:
Myriad-Dreamin 2025-06-23 13:13:55 +08:00 • committed by GitHub
parent b0c9b2ef86
commit d76cd90ef5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/tinymist/feature/docs.typ
View file

@ -9,7 +9,8 @@ Tinymist will read the documentation from the source code and display it in the
= Status of the Feature
- #sym.checkmark Syntax of Docstring's Content: We have reached consensus on the syntax of content. It MUST be written in Typst.
- #sym.quest Annotations in Docstring's Content: We check the annotations in docstring by #link("https://typst.app/universe/package/tidy")[tidy style]. It's not an official standard.
- #sym.quest Annotations in Docstring's Content: We check the annotations in docstring by #link("https://typst.app/universe/package/tidy")[tidy style] (*< v0.4.0*). It's not an official standard.
- Related Issue: #link("https://github.com/Mc-Zen/tidy/issues/53")[Tidy \#53: Long-term compatibility with `tinymist`.]
- #sym.crossmark Syntax of Docstring: We haven't reached consensus on the syntax of docstring. It's not clear whether we should distinguish the docstring from regular comments.
= Format of Docstring