scalameta/metals

Missing documentation for "commands" in Emacs docs

Open

#5708 opened on Oct 3, 2023

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Scala (2,300 stars) (421 forks)batch import
documentationemacsgood first issue

Description

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

Contributor guide

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of EmacsFamiliarity with Metals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.