adambard/learnxinyminutes-docs

[Vimscript/en] line continuation and calling user functions

Open

#3844 opened on Feb 6, 2020

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (10,755 stars) (3,235 forks)batch import
enhancementhelp wantedwork in progress

Description

As a 20+ years user of Vim, I was pleased to see a description of Vimscript AKA VimL included. However there are a couple of small items that need to be fixed. If HiPhish doesn't get to them, I'll see if I can get a PR ready. (It's been a while :))

Lines 45-46: "... pacing [sic] a backslash as the first non-whitespace ... " Changing the obvious typo to "placing" improves the sentence, but it could be smoother. Perhaps "typing a backslash" or "writing a backslash". "placing" does work, though.

Lines 491-492: The text states that one cannot call a user function directly. That's not true in an expression, say something like: :let x = myFunction(). True, :myFunction() isn't legal & requires :call myFunction(). (Maybe this is something Bram will "fix" in Vim9)

Contributor guide

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.
stale
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.
90
Research direction
The issue identifies two fixes in the Vimscript document: a typo on lines 45-46 ("pacing" to "placing") and a correction on lines 491-492 about calling user functions. The fix involves editing the markdown file for Vimscript in the repository. No code changes are needed, only text corrections.