jashkenas/coffeescript

Proposal: multiline should be documented inside REPL

Open

#5,114 opened on Oct 1, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CoffeeScript (1,980 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (16,577 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I eventually found the Ctrl-V answer in StackOverflow, but not before I'd used the REPL for about 2 weeks thinking that multiline was broken in the REPL. Also, while StackOverflow told me to use Ctrl-V to enter multiline mode, it didn't mention to use that keycode to exit. So, as a Unix user, I hit Ctrl-D and the REPL quit. It would be nice if the REPL told people about Ctrl-V to enter and exit multiline mode. Also, it would be nice if it told people about .help.

CoffeeScript version 2.3.1 Node v10.4.0

Contributor guide

Research direction
Update the REPL's help message to include instructions for entering and exiting multiline mode using Ctrl V and mention the .help command.
Tech stack
None
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80