Empty links warn #28
Open
Empty links warn #28
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
|
I appreciate the PR, but with regard to #27, it would be helpful if we decided what to do in plain English before deciding how to change the code. If you'd like, please discuss some ideas there first. |
psionic-k
force-pushed
the
master
branch
3 times, most recently
from
ea31461 to
334aa14
Compare
This commit makes the string comparison avoid failure when the title component is nil, (it's not an empty string). This occurs for example when a headline is just a TODO cookie with no later headline text. The two blocks for generating the link properly attempt to skip headlines where there is no 4th title component, so later generation correctly handles the case where an empty link generation would be attempted in the TOC. Note, empty links would not render or behave, so forcing their generation would be incorrect anyway. Signed-off-by: Psionik K <73710933+psionic-k@users.noreply.github.com>
This change correctly reports the line where a headline returned nul from the call to `org-heading-components'. Warnings are delayed and displayed after the command to generate the TOC completes. Signed-off-by: Psionik K <73710933+psionic-k@users.noreply.github.com>
psionic-k
commented
Nov 28, 2022
| (string-match-p (rx bos "COMMENT" (or blank eos)) headline-text))) | ||
| (if-let ((headline-text (nth 4 (org-heading-components)))) | ||
| (string-match-p (rx bos "COMMENT" (or blank eos)) headline-text) | ||
| (delay-warning 'org-make-toc |
There was a problem hiding this comment.
I didn't understand the manual or docstring's explanation of the TYPE argument to delay-warning, but use-package macros expand such that they use the package name symbol when calling display-warning. As far as I can tell, any symbol is accepted, and the output to the user looks informative when done this way.
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.
Normalizing away nils in the 4th header component results in org warning the user that they have an empty link. The TOC does not finish generation in this case.
At first I just fixed the string-match-p call, but this will complete without generating user feedback about the empty title.
fixes #27
fixes #13
Signed-off-by: Psionik K 73710933+psionic-k@users.noreply.github.com