Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Is there a way to eliminate single-line breaks from doc comments?

See original GitHub issue

When writing C# doc comments, I manually wrap text to keep lines from getting too long (e.g. this file). However, this wrapping is preserved in the output markdown files, which looks a bit awkward.

Any thoughts on how to improve the formatting? Ideally for me the tool would retain paragraph breaks but not retain line breaks except in <code> blocks.

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

Dorakucommented, Aug 9, 2022

Yeah even if it is a “breaking change” it shouldn’t affect most people and it’s better to be in line with how the intellisense behave.

Dorakucommented, Aug 8, 2022

There’s a setting just for that 😃 You can also locally change this settings in your xml elements by setting a ignorelinebreak attribute in your documentation <summary ignorelinebreak="true">

Read more comments on GitHub >

github_iconTop Results From Across the Web

Can I “automate” the deletion of line/paragraph breaks?
Select the lines of that paragraph and press Ctrl+J or go to Edit -> Line Operations -> Join Lines. This will remove all...
Read more >
MS Word: Remove Line Breaks from Pasted Text
Highlight the pasted text from which you would like to remove line breaks. In MS Word 2010, press [Ctrl] [H] to access the...
Read more >
How do I remove linebreaks in Notepad++?
Highlight the lines you want to join (or use Ctrl + A to select everything); Choose Edit → Line Operations → Join Lines...
Read more >
Replace Line, Paragraph, Carriage Break in MS Word
Learn to replace line break, paragraph break, carriage return (enter key) and new line with comma or anything else. MS Word can Find...
Read more >
Getting rid of hard line breaks in pasted text
I quite often copy and paste text from Adobe Acrobat documents rather than retype it, but by far the biggest hassle is having...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found