feat: add support for user comments in presentation rendering #773
Conversation
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
mfontanini
reviewed
Nov 20, 2025
Owner
mfontanini
left a comment
mfontanini
left a comment
There was a problem hiding this comment.
Sorry, I've been out for a while and this slipped through. A couple of comments but looks good overall!
|
|
||
| // Ignore user comments with Comment: prefix (case-insensitive) | ||
| // e.g., <!-- Comment: This is a comment --> | ||
| if trimmed_comment.len() >= 8 { |
Owner
There was a problem hiding this comment.
The comment: case is better handled if you add it to the CommentCommand enum, e.g.
enum CommentCommand {
// ....
Comment(String)
}Which is then ignored in the match that handles this. I also don't think making this case insensitive makes sense here given no other comment command is case insensitive.
|
|
||
| Customizability | ||
| --- | ||
| <!-- Comment: You can add comments like this that won't show up in the presentation --> |
Owner
There was a problem hiding this comment.
I wouldn't touch the demo presentation for this feature. The docs are the ultimate guide, this is just here to show the most commonly used features.
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've found the function
should_ignore_commentand have been relying on it to add user comments inside presentations by abusing the<!-- vim: comment here -->since I don't use vim for this anyways.This isn't clean and a dedicated way to comment should be added IMO. Also, there is an issue with the hacky vim solution above, it adds a newline where the comment should be ignored; fixed by using
self.slide_state.ignore_element_line_break = trueon ignored comments.Current comments:
PR with ignore line breaks:
