From cf85392d257bb1e317428c66541145cf347ebef4 Mon Sep 17 00:00:00 2001 From: SpacemacsBot Date: Thu, 30 Jan 2025 18:48:37 +0000 Subject: [PATCH] [bot] "documentation_updates" Thu Jan 30 18:48:37 UTC 2025 --- COMMUNITY.org | 3 --- CONTRIBUTING.org | 2 +- doc/DOCUMENTATION.org | 5 +++-- doc/LAYERS.org | 12 ++++++------ layers/+emacs/org/README.org | 2 +- layers/+email/gnus/README.org | 2 +- layers/+lang/python/README.org | 2 ++ layers/+tools/lsp/README.org | 9 ++++----- layers/LAYERS.org | 7 ++++--- 9 files changed, 22 insertions(+), 22 deletions(-) diff --git a/COMMUNITY.org b/COMMUNITY.org index d9b5363da027..beb74e9c7585 100644 --- a/COMMUNITY.org +++ b/COMMUNITY.org @@ -55,7 +55,6 @@ part in Spacemacs is the evil mode :-) ** Guidelines These guidelines apply to all collaborators of the project, namely: - - [[https://github.com/syl20bnr][@syl20bnr]] - [[https://github.com/JAremko][@JAremko]] - [[https://github.com/smile13241324][@smile13241324]] @@ -63,7 +62,6 @@ These guidelines apply to all collaborators of the project, namely: - [[https://github.com/fnussbaum][@fnussbaum]] And they applied to all former collaborators during their period of activity: - - [[https://github.com/lebensterben][@lebensterben]] - [[https://github.com/bmag][@bmag]] - [[https://github.com/duianto][@duianto]] @@ -138,4 +136,3 @@ moderation actions have been taken: |------------+-----------+--------+-------+-----------------------------------------------------------------| | 2016/01/27 | syl20bnr | lock | #3484 | comments judged to be offending towards the Spacemacs community | | 2016/01/27 | syl20bnr | unlock | #3484 | let's make it happen, i.e. this document | - diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org index 40d9bf5a1d0e..ed92e6b4155e 100644 --- a/CONTRIBUTING.org +++ b/CONTRIBUTING.org @@ -368,7 +368,7 @@ To add tests for a layer, do the following: functional tests. Look at existing tests for clues. 4. Write a =Makefile= in that folder. It should define three variables. - =LOAD_FILES= :: a list of additional files to load before testing (relative - to the root Spacemacs folder). This should typically be =init.el=. + to the root Spacemacs folder). This should typically be =init.el=. - =UNIT_TEST_FILES= :: a list of unit test files in the current folder. - =FUNC_TEST_FILES= :: a list of functional test files in the current folder. diff --git a/doc/DOCUMENTATION.org b/doc/DOCUMENTATION.org index 149b8a008c87..77318e86a66f 100644 --- a/doc/DOCUMENTATION.org +++ b/doc/DOCUMENTATION.org @@ -1210,11 +1210,12 @@ You can cycle between the themes declared in =dotspacemacs-themes= with For an external theme from a package, please add the theme and its package into the =dotspacemacs-themes=, then the Spacemacs will install the package and apply the theme. Here is an example: -#+begin_src emacs-lisp + +#+BEGIN_SRC emacs-lisp (setq-default dotspacemacs-themes '((humanoid-light :package humanoid-themes) spacemacs-dark)) -#+end_src +#+END_SRC *** Browsing themes You can see samples of all themes included in the =themes-megapack= layer diff --git a/doc/LAYERS.org b/doc/LAYERS.org index b98087f03b95..00ea9679dbce 100644 --- a/doc/LAYERS.org +++ b/doc/LAYERS.org @@ -41,13 +41,13 @@ layers with descriptions see [[https://spacemacs.org/layers/LAYERS.html][Spacema * Nomenclature Layers and packages. What gives? - Package :: A set of Emacs Lisp files that, taken together, provide some - feature. Packages may be available on a package repository, such as ELPA or - MELPA or on a third-party service provider (such as github) or even - locally on the disk. + feature. Packages may be available on a package repository, such as ELPA or + MELPA or on a third-party service provider (such as github) or even + locally on the disk. - Layer :: A collected unit of configuration that can be enabled (or disabled) - in Spacemacs. A layer typically brings together one or more packages, as - well as the glue configuration code required to make them play well with - each other and Spacemacs in general. + in Spacemacs. A layer typically brings together one or more packages, as + well as the glue configuration code required to make them play well with + each other and Spacemacs in general. Before writing a layer, it is helpful to consider what you are trying to achieve. Is there a package that provides the functionality you are after, and diff --git a/layers/+emacs/org/README.org b/layers/+emacs/org/README.org index a3811406493c..b5c328391569 100644 --- a/layers/+emacs/org/README.org +++ b/layers/+emacs/org/README.org @@ -442,10 +442,10 @@ the build in =project.el= alternative. (setq-default dotspacemacs-configuration-layers '((org :variables org-project-capture-projects-file "TODOs.org"))) #+END_SRC + You can also pass a function as `org-project-capture-projects-file`. This allows you to set file name based on project - #+BEGIN_SRC emacs-lisp (setq-default dotspacemacs-configuration-layers '((org :variables org-project-capture-projects-file '(lambda (arg) (concat (projectile-project-name) ".org"))))) diff --git a/layers/+email/gnus/README.org b/layers/+email/gnus/README.org index 3bfa31a21eb0..608df32f48cf 100644 --- a/layers/+email/gnus/README.org +++ b/layers/+email/gnus/README.org @@ -33,7 +33,7 @@ Gnus is a news reading application. The Gnus terminology can be confusing for new users so the basics are listed here: - Group :: A Newsgroup but can also be a RSS Feed or a mail directory - Topic :: Newsgroups can be assigned to topics which will be used to structure - the Group Buffer if Topic Mode is enabled(default). + the Group Buffer if Topic Mode is enabled(default). * Adding news sources Adding news sources can be done in your =.spacemacs= file by adding the diff --git a/layers/+lang/python/README.org b/layers/+lang/python/README.org index 79ff62f1d6c6..473171cf6594 100644 --- a/layers/+lang/python/README.org +++ b/layers/+lang/python/README.org @@ -322,6 +322,7 @@ The importmagic is a heavy feature, will take time to prepare the background server, especially slow with =ipython= or =ipython3=, set the =importmagic-python-interpreter= to =python= or =python3= (if it is the interpreter of ipython) will have performance benefit. Fox example: + #+BEGIN_SRC elisp (setq-default dotspacemacs-configuration-layers '((python :variables importmagic-python-interpreter "python3"))) @@ -329,6 +330,7 @@ interpreter of ipython) will have performance benefit. Fox example: To disable the importmagic, set the =python-enable-importmagic= in the python layer config section: + #+BEGIN_SRC elisp (setq-default dotspacemacs-configuration-layers '((python :variables python-enable-importmagic nil))) diff --git a/layers/+tools/lsp/README.org b/layers/+tools/lsp/README.org index 2e41ed3c0d64..db7e8f1af46f 100644 --- a/layers/+tools/lsp/README.org +++ b/layers/+tools/lsp/README.org @@ -189,12 +189,11 @@ To make ~company~ provide completion candidates from ~company-capf~ combined wit example, you can set it like this in your ~dotspacemacs/user-config~: #+BEGIN_SRC emacs-lisp -(add-hook 'go-mode-hook - (lambda () - (setq-local company-backends '(:separate company-capf company-files company-yasnippet)))) + (add-hook 'go-mode-hook + (lambda () + (setq-local company-backends '(:separate company-capf company-files company-yasnippet)))) #+END_SRC - * Key bindings A number of lsp features useful for all/most modes have been bound to the lsp minor mode, meaning they'll be available in all language layers based on the lsp layer. @@ -244,7 +243,7 @@ The lsp minor mode bindings are: | ~SPC m g r~ | find references (=xref= / =lsp=) | | ~SPC m g s~ | find symbol in project (=helm-lsp=) | | ~SPC m g S~ | find symbol in all projects (=helm-lsp=) | -| ~SPC m g p~ | goto previous (~xref-go-back~) | +| ~SPC m g p~ | goto previous (~xref-go-back~) | |---------------+----------------------------------------------------------------------------------| | Note | /Omitted when ~lsp-navigation~ is ~'peek~ or ~'simple~ / | | | /Bound under ~SPC m g~ rather than ~SPC m G~ when ~lsp-navigation~ == ~'peek~/ | diff --git a/layers/LAYERS.org b/layers/LAYERS.org index 7b1c75d90565..0bfb5d196421 100644 --- a/layers/LAYERS.org +++ b/layers/LAYERS.org @@ -284,7 +284,7 @@ THIS FILE IS AUTO-GENERATED! Don't edit it directly. See [[https://github.com/syl20bnr/spacemacs/blob/develop/CONTRIBUTING.org#readmeorg-tags]["README.org tags" section of CONTRIBUTING.org for the instructions]]. This is an overview of Spacemacs configuration layers. For information about -configuration layer development see [[https://spacemacs.org/doc/LAYERS.html][Configuration layers development]]. +configuration layer development see [[https://develop.spacemacs.org/doc/LAYERS.html][Configuration layers development]]. * Chats ** ERC @@ -849,6 +849,7 @@ Features: - occur-mode - package-menu - page-break-lines + - proced - process-menu - quickrun - recentf @@ -891,8 +892,8 @@ Features: - Support for sorting (press ~s~) via [[https://gitlab.com/xuhdev/dired-quick-sort][=dired-quick-sort=]] - Support for [[https://github.com/PythonNut/evil-easymotion][=evil-easymotion=]] if the editing style is =vim= or =hybrid=. - Support for cycling between multi line block styles via [[https://github.com/IvanMalison/multi-line/][=multi-line=]]. -- Support for editing strings inplace via [[https://github.com/magnars/string-edit.el][=string-edit=]] -- Presents undo history as a tree via [[https://gitlab.com/tsc25/undo-tree/-/blob/master/undo-tree.el][=undo-tree=]] +- Support for editing strings inplace via [[https://github.com/magnars/string-edit.el][=string-edit=]]. +- Presents undo history as a tree via [[https://github.com/casouri/vundo][=vundo=]] or [[https://gitlab.com/tsc25/undo-tree/-/blob/master/undo-tree.el][=undo-tree=]]. ** Spacemacs-editing-visual [[file:+spacemacs/spacemacs-editing-visual/README.org][+spacemacs/spacemacs-editing-visual/README.org]]