Fix docstring warnings by escaping single quotes and backticks #544
Conversation
This file contains 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
Escaped unquoted single quotes and backticks in docstrings to resolve
the following warnings:
leaf.el:????:2: Warning: docstring has wrong usage of unescaped single quotes
(use \=' or different quoting such as `...').
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Escaped unquoted single quotes and backticks in docstrings to resolve the following warnings.
Description
In leaf.el, certain docstrings caused warnings due to unescaped single quotes and backticks, as shown below:
This PR resolves these warnings by adding = before unquoted single quotes and backticks throughout the affected docstrings, ensuring they follow the recommended quoting conventions.
Checklist
make test.