Skip to content

multiline descriptions #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2021
Merged

multiline descriptions #524

merged 1 commit into from
May 25, 2021

Conversation

burrbull
Copy link
Member

Fixes #523

@burrbull burrbull requested a review from a team as a code owner May 25, 2021 19:04
@rust-highfive
Copy link

r? @ryankurte

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-tools labels May 25, 2021
@burrbull
Copy link
Member Author

burrbull commented May 25, 2021

@9ary Does this work as you expected?

@9ary
Copy link

9ary commented May 25, 2021

Look like it works, yes. Output is still not great because most of the descriptions are not actually valid markdown so single newlines get eaten, but I'm not sure it is svd2rust's job to fix that. The multiline descriptions are formatted for C headers, to be read in a plaintext editor.

Copy link
Member

@Emilgardis Emilgardis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors r+

@bors bors bot merged commit 5387769 into master May 25, 2021
@bors bors bot deleted the doc branch May 25, 2021 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Properly handle newlines in descriptions
5 participants