The Problem with the README Code

Oct 13, 2025 by wbrum.org 118 views

Introduction

Marginalia is a powerful Emacs package that provides a convenient way to navigate and explore your codebase. However, setting it up with use-package can be a bit tricky, especially when it comes to calling the marginalia-mode function. In this article, we will explore the correct way to set up Marginalia with use-package and address the question of how to call marginalia-mode in the :init section.

The Problem with the README Code

The README for Marginalia provides an example of how to set it up with use-package. However, the code seems to be incorrect. Here is the code as it appears in the README:

(use-package marginalia
  :demand t
  :bind (:map minibuffer-local-map
	 ("M-A" . marginalia-cycle))
  :config (marginalia-mode)
  )

The issue with this code is that it tries to call marginalia-mode in the :config section, which is executed after the package has been loaded. However, in the :init section, the package has not yet been loaded, so calling marginalia-mode will result in an error.

The Correct Way to Set Up Marginalia with Use-Package

To set up Marginalia with use-package correctly, we need to call marginalia-mode in the :init section, but only after the package has been loaded. We can achieve this by using the :demand keyword, which ensures that the package is loaded before executing the :init section.

Here is the corrected code:

(use-package marginalia
  :demand t
  :bind (:map minibuffer-local-map
	 ("M-A" . marginalia-cycle))
  :init (marginalia-mode)
  )

In this code, we use the :init section to call marginalia-mode, and we use the :demand keyword to ensure that the package is loaded before executing the :init section.

Why This Works

When we use the :demand keyword, Emacs ensures that the package is loaded before executing the :init section. This means that when we call marginalia-mode in the :init section, the package has already been loaded, and the function is available.

Conclusion

In conclusion, setting up Marginalia with use-package requires a bit of care, especially when it comes to calling the marginalia-mode function. By using the :demand keyword and calling marginalia-mode in the :init section, we can ensure that the package is loaded correctly and that the function is available when we need it.

Additional Tips and Tricks

Here are a few additional tips and tricks for setting up Marginalia with use-package:

Make sure to add the :demand keyword to ensure that the package is loaded before executing the :init section.
Use the :bind keyword to bind the marginalia-cycle function to a key of your choice.
Experiment with different key bindings to find the one that works best for you.
Consider adding additional configuration options to customize the behavior of Marginalia.

Common Issues and Solutions

Here are a few common issues that you may encounter when setting up Marginalia with use-package, along with their solutions:

Issue: Marginalia is not loading correctly.
Solution: Check that you have added the :demand keyword and that you are calling marginalia-mode in the :init section.
Issue: Marginalia is not binding correctly to the key of your choice.
Solution: Check that you have added the :bind keyword and that you have specified the correct key binding.
Issue: Marginalia is not working as expected.
Solution: Check that you have added the correct configuration options and that you have customized the behavior of Marginalia to your liking.

Conclusion

Introduction

In our previous article, we explored the correct way to set up Marginalia with use-package. However, we know that there are often many questions and concerns when it comes to setting up a new package. In this article, we will address some of the most frequently asked questions about setting up Marginalia with use-package.

Q: What is the difference between :init and :config in use-package?

A: In use-package, :init and :config are two different sections that are executed at different times. The :init section is executed before the package is loaded, while the :config section is executed after the package is loaded. This means that in the :init section, you can only use functions that are available before the package is loaded, while in the :config section, you can use functions that are available after the package is loaded.

Q: Why do I need to use :demand t in use-package?

A: When you use :demand t in use-package, Emacs ensures that the package is loaded before executing the :init section. This is necessary because in the :init section, you may need to use functions that are available after the package is loaded. By using :demand t, you can ensure that the package is loaded correctly and that the functions are available when you need them.

Q: Can I use :bind to bind multiple keys to Marginalia functions?

A: Yes, you can use :bind to bind multiple keys to Marginalia functions. For example, you can use the following code to bind the marginalia-cycle function to both M-A and C-M-A:

(use-package marginalia
  :demand t
  :bind (:map minibuffer-local-map
	 ("M-A" . marginalia-cycle)
	 ("C-M-A" . marginalia-cycle))
  :init (marginalia-mode)
  )

Q: How can I customize the behavior of Marginalia?

A: You can customize the behavior of Marginalia by adding additional configuration options to your use-package configuration. For example, you can use the following code to customize the key binding and the behavior of Marginalia:

(use-package marginalia
  :demand t
  :bind (:map minibuffer-local-map
	 ("M-A" . marginalia-cycle))
  :init (marginalia-mode)
  :custom-face (marginalia-highlight-face '(:background "light blue" :foreground "black"))
  )

Q: Can I use Marginalia with other packages?

A: Yes, you can use Marginalia with other packages. In fact, Marginalia is designed to work seamlessly with other packages, including use-package. You can use Marginalia with other packages by adding the necessary configuration options to your use-package configuration.

Q: How can I troubleshoot issues with Marginalia?

A: If you encounter issues with Marginalia, you can troubleshoot them by checking the following:

Make sure that you have added the correct configuration options to your use-package configuration.
Check that you have loaded the package correctly.
Check that you have bound the correct keys to the Marginalia functions.
Check that you have customized the behavior of Marginalia correctly.

Conclusion

In conclusion, setting up Marginalia with use-package requires a bit of care, but with the correct configuration and a few additional tips and tricks, you can ensure that the package is loaded correctly and that the function is available when you need it. By following the guidelines outlined in this article, you can set up Marginalia with use-package and start exploring your codebase with ease.

Additional Resources

Here are a few additional resources that you may find helpful when setting up Marginalia with use-package:

The Marginalia documentation: This is the official documentation for Marginalia, and it provides a wealth of information on how to use the package.
The use-package documentation: This is the official documentation for use-package, and it provides a wealth of information on how to use the package.
The Emacs wiki: This is a community-driven wiki that provides a wealth of information on Emacs and its packages, including Marginalia and use-package.

Conclusion

In conclusion, setting up Marginalia with use-package is a bit of a process, but with the correct configuration and a few additional tips and tricks, you can ensure that the package is loaded correctly and that the function is available when you need it. By following the guidelines outlined in this article, you can set up Marginalia with use-package and start exploring your codebase with ease.