Skip to content

Commit 216f266

Browse files
committed
Fix verbs in some docstrings
1 parent 7fa98af commit 216f266

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,9 @@ The package can be installed with `guix package -i emacs-vterm`.
177177

178178
## Shell-side configuration
179179

180-
Some of the most useful features in `vterm` (e.g.,
181-
[directory-tracking and prompt-tracking](#directory-tracking-and-prompt-tracking) or
182-
[message passing](#message-passing)) require shell-side configurations. The main goal of
180+
Some of the most useful features in `vterm` (e.g., [directory-tracking and
181+
prompt-tracking](#directory-tracking-and-prompt-tracking) or [message
182+
passing](#message-passing)) require shell-side configurations. The main goal of
183183
these additional functions is to enable the shell to send information to `vterm`
184184
via properly escaped sequences. A function that helps in this task,
185185
`vterm_printf`, is defined below. This function is widely used throughout this

vterm-module.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,7 +1250,7 @@ int emacs_module_init(struct emacs_runtime *ert) {
12501250
// Exported functions
12511251
emacs_value fun;
12521252
fun =
1253-
env->make_function(env, 4, 6, Fvterm_new, "Allocates a new vterm.", NULL);
1253+
env->make_function(env, 4, 6, Fvterm_new, "Allocate a new vterm.", NULL);
12541254
bind_function(env, "vterm--new", fun);
12551255

12561256
fun = env->make_function(env, 1, 5, Fvterm_update,
@@ -1266,11 +1266,11 @@ int emacs_module_init(struct emacs_runtime *ert) {
12661266
bind_function(env, "vterm--write-input", fun);
12671267

12681268
fun = env->make_function(env, 3, 3, Fvterm_set_size,
1269-
"Sets the size of the terminal.", NULL);
1269+
"Set the size of the terminal.", NULL);
12701270
bind_function(env, "vterm--set-size", fun);
12711271

12721272
fun = env->make_function(env, 2, 2, Fvterm_set_pty_name,
1273-
"Sets the name of the pty.", NULL);
1273+
"Set the name of the pty.", NULL);
12741274
bind_function(env, "vterm--set-pty-name", fun);
12751275
fun = env->make_function(env, 2, 2, Fvterm_get_pwd,
12761276
"Get the working directory of at line n.", NULL);
@@ -1280,7 +1280,7 @@ int emacs_module_init(struct emacs_runtime *ert) {
12801280
bind_function(env, "vterm--reset-point", fun);
12811281

12821282
fun = env->make_function(env, 1, 1, Fvterm_get_icrnl,
1283-
"Gets the icrnl state of the pty", NULL);
1283+
"Get the icrnl state of the pty", NULL);
12841284
bind_function(env, "vterm--get-icrnl", fun);
12851285

12861286
provide(env, "vterm-module");

vterm.el

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -434,9 +434,8 @@ Only background is used."
434434
(defvar vterm-timer-delay 0.1
435435
"Delay for refreshing the buffer after receiving updates from libvterm.
436436
437-
Improves performance when receiving large bursts of data.
438-
If nil, never delay.
439-
The units are seconds.")
437+
A larger delary improves performance when receiving large bursts
438+
of data. If nil, never delay. The units are seconds.")
440439

441440
;;; Keybindings
442441

@@ -588,7 +587,7 @@ Exceptions are defined by `vterm-keymap-exceptions'."
588587
:connection-type 'pty
589588
:filter #'vterm--filter
590589
;; The sentinel is needed if there are exit functions or if
591-
;; vterm-kill-buffer-on-exit is set to t. In this latter case,
590+
;; vterm-kill-buffer-on-exit is set to t. In this latter case,
592591
;; vterm--sentinel will kill the buffer
593592
:sentinel (when (or vterm-exit-functions
594593
vterm-kill-buffer-on-exit)

0 commit comments

Comments
 (0)