Document which comments are excluded from wrapping #5637
Merged
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
ytmimi
reviewed
Dec 23, 2022
Comment on lines
+3004
to
+3007
| Note that no wrapping will happen if: | ||
| 1. The comment is the start of a markdown header doc comment | ||
| 2. An URL was found in the comment | ||
|
|
There was a problem hiding this comment.
Thank you for updating the docs! I think it would be best to add this note to the description above. So right after "Break comments to fit on the line". I think we could maybe elaborate on the descriptions a little bit as well, but just having this is a huge step in the right direction.
It would also be great to include examples of these cases into the false and true cases listed bellow so users can visually see the difference! If you wouldn't mind tracking down examples from the issues (or their respective PRs) that I mentioned in #5634 (comment) that would be fantastic!
Comment on lines
+804
to
+805
| // If this changes, the documentation in ../Configurations.md#wrap_comments | ||
| // should be changed accordingly. |
ytmimi
approved these changes
Jan 11, 2023
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.
Cf: #5634