Skip to content

Commit 4eb59cb

Browse files
committed
docs(documentation): regenerate the documentation
1 parent 726dc09 commit 4eb59cb

File tree

1 file changed

+9
-23
lines changed

1 file changed

+9
-23
lines changed

docs/DOCS.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,6 @@ Level of printed messages.
4444
2 - `+info!`
4545
3 - `+log!`
4646

47-
#### `minemacs-leader-key`
48-
49-
MinEmacs leader key.
50-
51-
#### `minemacs-localleader-key`
52-
53-
MinEmacs local leader (a.k.a. mode specific) key sequence.
54-
55-
#### `minemacs-global-leader-prefix`
56-
57-
MinEmacs general leader key.
58-
59-
#### `minemacs-global-mode-prefix`
60-
61-
MinEmacs general local leader (a.k.a. mode specific) key sequence.
62-
6347
#### `minemacs-theme`
6448

6549
The theme of MinEmacs.
@@ -328,13 +312,9 @@ Set the standard value of VARIABLE to VALUE.
328312

329313
Return the standard value for VARIABLE.
330314

331-
#### `(+reset-sym SYM)`
332-
333-
Reset SYM to its standard value.
315+
#### `(+reset-standard-value VARIABLE)`
334316

335-
#### `(+reset-var! VAR)` (macro)
336-
337-
Reset VAR to its standard value.
317+
Reset VARIABLE to its standard value.
338318

339319
#### `(+unquote EXPR)`
340320

@@ -440,9 +420,11 @@ Queue FNS to be byte/natively-compiled after a brief delay.
440420
#### `(+shell-command-to-string-ignore-stderr COMMAND)`
441421

442422
Execute shell command COMMAND and return its output as a string.
443-
Works like `shell-command-to-string` with two differences:
423+
Works like `shell-command-to-string` with three differences:
444424
1. It uses `+shell-command-switch` instead of `shell-command-switch`.
445425
2. It returns only stdout and ignore the output of stderr.
426+
3. It sets TERM to "smart" instead of "dumb", to be able to escape from
427+
Emacs-specific early exit in ".bashrc".
446428

447429
#### `(+env-save)`
448430

@@ -461,6 +443,10 @@ Add ROOTS to ignored projects, recentf, etc.
461443
Is package PACKAGE disabled in `minemacs-disabled-packages`.
462444
Optionally, check also for the containing MODULE.
463445

446+
#### `(minemacs-modules &optional INCLUDE-OBSOLETE)`
447+
448+
List all the available modules, with optional INCLUDE-OBSOLETE.
449+
464450
#### `(+file-read-to-string FILENAME)`
465451

466452
Return a string with the contents of FILENAME.

0 commit comments

Comments
 (0)