mirror of
https://github.com/Myriad-Dreamin/tinymist.git
synced 2025-11-24 05:06:41 +00:00
4ce0a59862
Some checks are pending
tinymist::auto_tag / auto-tag (push) Waiting to run
tinymist::ci / announce (push) Blocked by required conditions
tinymist::ci / build (push) Blocked by required conditions
tinymist::ci / prepare-build (push) Waiting to run
tinymist::ci / Check Minimum Rust version and Tests (Windows) (push) Waiting to run
tinymist::ci / Duplicate Actions Detection (push) Waiting to run
tinymist::ci / Check Clippy, Formatting, Completion, Documentation, and Tests (Linux) (push) Waiting to run
tinymist::gh_pages / build-gh-pages (push) Waiting to run
This PR adds comprehensive documentation for all public items in `crates/tinymist-query/src/syntax/expr.rs` following Rust documentation conventions. ## Changes Made The following public items now have proper documentation comments: - **`ExprRoute`** type alias - Documents its purpose as a mapping structure for file identifiers to lexical scopes during expression analysis routing - **`expr_of`** function - Describes its role in analyzing expressions within source files and producing expression information including resolves, imports, docstrings, and lexical scoping data - **`ExprWorker`** struct - Explains its functionality as a worker for processing expressions during source file analysis, handling expression checking, scope management, symbol resolution, and docstring collection ## Documentation Style All documentation follows Rust conventions by: - Using third person singular verbs - Focusing on the purpose and functionality rather than implementation details - Providing clear, concise descriptions of what each item does The code has been formatted with `cargo fmt` and compiles successfully after the changes. Fixes #2048. <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Myriad-Dreamin <35292584+Myriad-Dreamin@users.noreply.github.com> Co-authored-by: Myriad-Dreamin <camiyoru@gmail.com> |
||
|---|---|---|
| .. | ||
| adt | ||
| analysis | ||
| code_action | ||
| completion | ||
| docs | ||
| fixtures | ||
| syntax | ||
| testing | ||
| analysis.rs | ||
| bib.rs | ||
| check.rs | ||
| code_action.rs | ||
| code_context.rs | ||
| code_lens.rs | ||
| color_presentation.rs | ||
| completion.rs | ||
| diagnostics.rs | ||
| document_color.rs | ||
| document_highlight.rs | ||
| document_link.rs | ||
| document_metrics.rs | ||
| document_symbol.rs | ||
| folding_range.rs | ||
| goto_declaration.rs | ||
| goto_definition.rs | ||
| hover.rs | ||
| inlay_hint.rs | ||
| jump.rs | ||
| lib.rs | ||
| lsp_typst_boundary.rs | ||
| on_enter.rs | ||
| package.rs | ||
| prelude.rs | ||
| prepare_rename.rs | ||
| references.rs | ||
| rename.rs | ||
| selection_range.rs | ||
| semantic_tokens_delta.rs | ||
| semantic_tokens_full.rs | ||
| signature_help.rs | ||
| symbol.rs | ||
| tests.rs | ||
| will_rename_files.rs | ||
| workspace_label.rs | ||