move code comment to callout #12536
Merged
move code comment to callout #12536
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
spring-projects-issues
added
the
status: waiting-for-triage
|
Thanks for finding and fixing this one. Is there a way for this to work as a comment. Part of the reason we do it in comments is to ensure copy / pasted code still has the information in it. |
|
Yep. That was the UI PR I sent about the code phrase. But using formatting
substitutions on a code block is very non portable and thus I consider it
an anti pattern.
|
|
In theory, it would be possible to have the copy button include the content from the callout list, similar to how the code modifies the copy content for a folded code block. But if there is still a preference to have the comment directly in the code, I would strongly advise to have it just be plain text. The link and formatting isn't going to get picked up on a copy anyway. |
jzheaux
added
in: docs
|
Sorry for the confusion. Somehow I missed that antora markup was being used in the code comment. I think this makes sense and have merged it. |
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.
Code comments should be placed in callouts, especially when they contain formatting and links. Otherwise, it breaks the layout of the page, as you can see in this code listing: