Skip to content

Commit

Permalink
[bot] "documentation_updates" Thu Jan 30 18:48:37 UTC 2025
Browse files Browse the repository at this point in the history
  • Loading branch information
SpacemacsBot committed Jan 30, 2025
1 parent c27f0a0 commit cf85392
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 22 deletions.
3 changes: 0 additions & 3 deletions COMMUNITY.org
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,13 @@ 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]]
- [[https://github.com/bcc32][@bcc32]]
- [[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]]
Expand Down Expand Up @@ -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 |

2 changes: 1 addition & 1 deletion CONTRIBUTING.org
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 3 additions & 2 deletions doc/DOCUMENTATION.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions doc/LAYERS.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion layers/+emacs/org/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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")))))
Expand Down
2 changes: 1 addition & 1 deletion layers/+email/gnus/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions layers/+lang/python/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -322,13 +322,15 @@ 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")))
#+END_SRC

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)))
Expand Down
9 changes: 4 additions & 5 deletions layers/+tools/lsp/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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~/ |
Expand Down
7 changes: 4 additions & 3 deletions layers/LAYERS.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -849,6 +849,7 @@ Features:
- occur-mode
- package-menu
- page-break-lines
- proced
- process-menu
- quickrun
- recentf
Expand Down Expand Up @@ -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]]
Expand Down

0 comments on commit cf85392

Please sign in to comment.