From 9bf607c85ed4e33dcfa883a6dfb8d1fa4496d845 Mon Sep 17 00:00:00 2001 From: Abdelhak Bougouffa Date: Wed, 20 Nov 2024 08:39:26 +0100 Subject: [PATCH] docs: generate the documentation --- docs/DOCS.md | 46 ++++++++++++++-------------------------------- docs/PACKAGES.md | 2 +- 2 files changed, 15 insertions(+), 33 deletions(-) diff --git a/docs/DOCS.md b/docs/DOCS.md index 9d52fb0c..eaf4c957 100644 --- a/docs/DOCS.md +++ b/docs/DOCS.md @@ -371,18 +371,6 @@ value of this method instead of the original alist, to ensure correct results. Duplicate elements in MODE-ALIST to include Treesit modes. For the alist =((some-mode . spec)), this will add =(some-ts-mode . spec). -#### `(+set-standard-value VARIABLE VALUE)` - -Set the standard value of VARIABLE to VALUE. - -#### `(+standard-value VARIABLE)` - -Return the standard value for VARIABLE. - -#### `(+reset-standard-value VARIABLE)` - -Reset VARIABLE to its standard value. - #### `(+unquote EXPR)` Return EXPR unquoted. @@ -396,6 +384,12 @@ Return t when EXPR is quoted. Like `apply-partially`, but apply the ARGS to the right of FUN. +#### `(+apply-inhibit-messages FN &rest ARGS)` + +Call FN with ARGS while to suppressing the messages in echo area. +If `minemacs-verbose-p` is non-nil, do not print any message to +*Messages* buffer. + #### `(+error! MSG &rest VARS)` (macro) Log error MSG and VARS using `message`. @@ -412,20 +406,11 @@ Log MSG and VARS using `message` when `minemacs-verbose-p` is non-nil. Log debug MSG and VARS using `message` when `minemacs-msg-level` is 4. -#### `(+fn-inhibit-messages! FN &optional NO-MESSAGE-LOG)` (macro) - -Add an advice around the function FN to suppress messages in echo area. -If NO-MESSAGE-LOG is non-nil, do not print any message to *Messages* buffer. - #### `(+shutup! &rest BODY)` (macro) Suppress new messages temporarily while evaluating BODY. This inhebits both the echo area and the `*Messages*` buffer. -#### `(+cmdfy! &rest BODY)` (macro) - -Convert BODY to an interactive command. - #### `(+load-theme)` Load Emacs' theme from `minemacs-theme`. @@ -503,6 +488,11 @@ Optionally, check also for the containing MODULE. List all the available modules. With optional INCLUDE-ON-DEMAND and INCLUDE-OBSOLETE. +#### `(+describe-random-command)` + +Show the documentation for a random command. +Consider only documented, non-obsolete interactive functions. + #### `(+shell-command-to-string-ignore-stderr COMMAND)` Execute shell command COMMAND and return its output as a string. @@ -539,9 +529,9 @@ that directory. Return non-nil if the resource NAME is locked. -#### `(+locked-by-this-process-p NAME)` +#### `(+locked-by-current-process-p NAME)` -Return non-nil if the resource NAME locked by this Emacs instance. +Return non-nil if the resource NAME locked by the current Emacs instance. #### `(+lock NAME)` @@ -564,7 +554,7 @@ be deleted. Auto-enable Eglot in configured modes in `+eglot-auto-enable-modes`. -#### `(+eglot-use-on-all-supported-modes MODE-LIST)` +#### `(+eglot-use-on-all-supported-modes &optional MODE-LIST)` Add all modes in MODE-LIST to `+eglot-auto-enable-modes`. @@ -608,14 +598,6 @@ Set *_proxy Linux environment variables from PROXIES. Unset *_proxy Linux environment variables. -#### `(+with-proxies &rest BODY)` (macro) - -Execute BODY with proxies enabled from `minemacs-proxies`. - -#### `(+with-no-proxies &rest BODY)` (macro) - -Execute BODY with proxies disabled. - #### `(+serialize-sym SYM &optional DIR FILENAME-FORMAT)` Serialize SYM to DIR. diff --git a/docs/PACKAGES.md b/docs/PACKAGES.md index e6e25936..d9018b78 100644 --- a/docs/PACKAGES.md +++ b/docs/PACKAGES.md @@ -288,7 +288,7 @@ * `magit`: It's Magit! A Git Porcelain inside Emacs. * `git-commit`: Edit Git commit messages - part of `magit` * `magit-todos`: Show source files' TODOs (and FIXMEs, etc) in Magit status buffer -* `magit-iconify`: File icons for Magit based on `nerd-icons` +* `magit-file-icons`: File icons for Magit based on `nerd-icons` * `magit-imerge`: Magit extension for "git-imerge" * `multi-magit`: A set of extensions for `magit` to handle multiple repositories simultaneously * `closql`: Store EIEIO objects using EmacSQL