Open
Conversation
* The `dumb-jump-extra-search-paths-function` docstring has a long line that
triggers the docstring-wide warning. Since it's difficult to refactor the
example text, I disabled the compiler docstring-wide around the defcustom
explicitly:
- I started using `(let ((byte-compile-warnings '(not docstrings-wide))) )`
block to surround the defcustom form, but that only work in Emacs 30 and
later.
- So I ended up using a with-no-warnings wrapping instead.
This will unfortunately disable all warnings inside that code...
Maybe you can find a way to express the example in
* The `dumb-jump-get-project-root` either call the new `project-root` if
available or `project-roots` in Emacs 26.x. However that triggers a warning
when compiled in later Emacs versions. I surround the code in a
`with-no-warnings` form to prevent the warning.
* In `dumb-jump-find-references`: prevent warning about `dump-jump-go`
as in the other functions using it.
* Reduced the length of the `dumb-jump-populate-regex-for-emacs` doctring
first line.
* Also removed the trailing spaces.
I would recommend to byte-compile the code with warnings treated as errors now
that warnings were eliminated from the code base.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis change modifies Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip CodeRabbit can suggest fixes for GitHub Check annotations.Configure the |
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
1 participant
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.
The
dumb-jump-extra-search-paths-functiondocstring has a long line that triggers the docstring-wide warning. Since it's difficult to refactor the example text, I disabled the compiler docstring-wide around the defcustom explicitly:(let ((byte-compile-warnings '(not docstrings-wide))) )block to surround the defcustom form, but that only work in Emacs 30 and later.The
dumb-jump-get-project-rooteither call the newproject-rootif available orproject-rootsin Emacs 26.x. However that triggers a warning when compiled in later Emacs versions. I surround the code in awith-no-warningsform to prevent the warning.In
dumb-jump-find-references: prevent warning aboutdump-jump-goas in the other functions using it.Reduced the length of the
dumb-jump-populate-regex-for-emacsdoctring first line.Also removed the trailing spaces.
I would recommend to byte-compile the code with warnings treated as errors now that warnings were eliminated from the code base.
Summary by CodeRabbit
Documentation
Style