Markdown parsing in doc comments #5891
Draft
+279
−63
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
2 tasks
ModProg
force-pushed
the
derive-markdown
branch
from
10af7ac to
82ebbe7
Compare
ModProg
commented
Jan 26, 2025
Comment on lines
+207
to
+209
| [[example]] | ||
| name = "markdown-derive" | ||
| required-features = ["derive"] |
There was a problem hiding this comment.
We can remove this example or incorporate it in others once it's finished, was more for testing while developing.
ModProg
commented
Jan 26, 2025
Comment on lines
+135
to
+136
| // TODO If we decide not to support any colors, we can replace this with | ||
| // anstyle::Effects and remove the need for applying them all individually. |
There was a problem hiding this comment.
Decide whether we want to support colors.
ModProg
commented
Jan 26, 2025
Comment on lines
+147
to
+156
| let style_heading = Style::new().bold(); | ||
| let style_emphasis = Style::new().italic(); | ||
| let style_strong = Style::new().bold(); | ||
| let style_strike_through = Style::new().strikethrough(); | ||
| let style_link = Style::new().underline(); | ||
| // TODO decide how to style code | ||
| let style_code = Style::new().dimmed(); | ||
| let tab_width = 2; | ||
| // TODO UNICODE let list_symbol = '•'; | ||
| let list_symbol = '-'; |
There was a problem hiding this comment.
Decide markdown styling
ModProg
commented
Jan 26, 2025
Comment on lines
+241
to
+246
| // TODO for anything useful we'd need to know the terminal width | ||
| Event::Rule => { | ||
| writer.endline(); | ||
| writer.newline(); | ||
| write!(writer, "---\n\n"); | ||
| } |
There was a problem hiding this comment.
Should we render rule as --- or is there anything else we can do without terminal width
ModProg
force-pushed
the
derive-markdown
branch
from
82ebbe7 to
e906f16
Compare
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.
fixes #2389