scalameta/metals

Missing documentation for "commands" in Emacs docs

Open

#5,708 建立於 2023年10月3日

在 GitHub 查看
 (9 留言) (0 反應) (0 負責人)Scala (2,300 star) (421 fork)batch import
documentationemacsgood first issue

描述

Describe the bug

In the documentation of metals for Emacs there is this paragraph:

To get started with a worksheet you can either use the metals.new-scala-file command

and later:

Since Metals v0.11.7 it's now possible to run scalafix rules using a special command metals.scalafix-run.

There is no explanation for how to run such commands, however.

Expected behavior

An explanation of what a "command" is.

Operating system

None

Editor/Extension

Emacs (lsp-metals)

Version of Metals

web

Extra context or search terms

No response

貢獻者指南

技術棧
scala
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of EmacsFamiliarity with Metals
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
The issue points to the Metals documentation for Emacs, specifically the 'Getting started with worksheets' section, where references to commands like 'metals.new scala file' and 'metals.scalafix run' are made without explaining how to execute them. The fix involves adding a brief explanation of how to run these commands in Emacs, likely using `M x` or keybindings. The existing docs page at https://scalameta.org/metals/docs/editors/emacs should be updated. No linked PRs or comments suggest any work in progress.