micro-editor / micro-editor/micro

`showkey` command could be more intuitive

Open
#3,391 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
29.6k
Forks
1.4k
Avg merge
2d 18h
Merged PRs (30d)
10

Description

Description of the problem or steps to reproduce

I learned about the showkey command in https://github.com/zyedidia/micro/pull/3385#issuecomment-2229119874. These were the first things I tried:

  1. At first, I thought showkey would be interactive (it's not) like its namesake
  2. The message ("Please provide a key to show") doesn't exactly disagree with 1): Is it a prompt where I should type the keybinding? (nope)
  3. help showkey doesn't work

Maybe showkey could be interactive, like raw? No idea how difficult that might be.

Specifications

Commit hash: 68d88b57
OS: macOS Sonoma 14.5
Terminal: Ghostty

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the showkey command and its help registration, then compare its behavior with the raw command and the referenced Linux showkey. Clarify whether the intended outcome is interactive input, clearer messaging, working help, or a combination; done should mean the command's behavior and usage are intuitive and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.