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.