Separate command key substitution and example block enclosing #1156
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 following form :
produces the following error in emacs 28+ :
This is what makes the function
yas--document-symbol
error out during documentation build (see #1147). This form must have been valid in previous versions of emacs.This specific block of the function
yas--document-symbol
:aims to do two different things at once, namely enclosing strings like
\\{yas-minor-mode-map}
in an org-example block and substituting these strings with the pretty-formatted content of said minor mode map. It would be more robust to do only one of those things at a time, at a cost of a second parsing of the string. On top that, the very next block of the same function :body (substitute-command-keys body)
does the substitution on the whole block, which makes the form
(substitute-command-keys match)
in the previous block unneeded.The change in commit c24c426 is therefore a simple fix to the documentation build failure, that does not change the output of the function
yas--document-symbol
.(fix #1147)
Best,
Aymeric Agon-Rambosson