adambard/learnxinyminutes-docs

[Vimscript/en] line continuation and calling user functions

Open

#3,844 opened on Feb 6, 2020

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

Repository metrics

Stars
 (10,755 stars)
PR merge metrics
 (Avg merge 23d 19h) (8 merged PRs in 30d)

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

Research direction
Fix the typo 'pacing' to 'placing' or 'writing' in line 45-46, and correct the statement in lines 491-492 to clarify that user functions can be called in expressions (e.g., :let x = myFunction()) but not directly with :myFunction().
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.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90