docs: added emacs to editor integration docs#256
Merged
mbhall88 merged 2 commits intosnakemake:masterfrom Jul 22, 2025
Merged
Conversation
📝 WalkthroughWalkthroughThe documentation for editor integration was updated to add instructions for using the Changes
Sequence Diagram(s)No sequence diagram is generated as the changes are limited to documentation updates. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/editor_integration.md (3)
15-15: Fix invalid anchor in TOC for Emacs
markdownlintflags the fragment#Emacsas invalid because GitHub’s automatic anchor for## Emacsis lower-case (#emacs).
Update the link so the jump works in rendered Markdown.- - [Emacs](#Emacs) + - [Emacs](#emacs)
117-119: Add language identifier to fenced code blockSpecify the language (
elisp/emacs-lisp) so syntax highlighting works and MD040 is satisfied.-``` +```elisp (add-hook 'prog-mode-hook 'format-all-mode)--- `114-121`: **Warn about broad `prog-mode-hook` usage** Hooking `format-all-mode` into `prog-mode-hook` means *every* programming buffer (e.g. C, JSON, YAML) will try to format on save, which may not be what most users want. Consider recommending a narrower hook such as `snakemake-mode` (from `snakemake-mode.el`) or providing both options. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 404d1408816ef39c5a4d224e151fe6ba0c3a8e8a and ca3d1e7381251e3438be06bf490717012020560a. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/editor_integration.md` (2 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>docs/editor_integration.md</summary> 15-15: Link fragments should be valid Expected: #emacs; Actual: #Emacs (MD051, link-fragments) --- 117-117: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 120-120: Emphasis style Expected: underscore; Actual: asterisk (MD049, emphasis-style) --- 120-120: Emphasis style Expected: underscore; Actual: asterisk (MD049, emphasis-style) </details> </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
twillis209
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I'm not sure how long
format-allhas supportedsnakefmt, but I thought it would be helpful to note that here.Summary by CodeRabbit
format-allpackage, including setup steps and links to related resources.