The Wayback Machine - https://web.archive.org/web/20210723030755/https://github.com/dotnet/command-line-api/issues/415
Skip to content

/ command-line-api

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

Jump to bottom

<summary> parsing by DragonFruit doesn't understand <para> #415

Open
drewnoakes opened this issue Feb 20, 2019 · 1 comment
Open

<summary> parsing by DragonFruit doesn't understand <para> #415

drewnoakes opened this issue Feb 20, 2019 · 1 comment
Labels
Area-DragonFruit Area-Help enhancement good first issue

Comments

@drewnoakes
Copy link
Member

@drewnoakes drewnoakes commented Feb 20, 2019

I'd like a line break in the help text produced from <summary> docs.

It seems that line breaks are ignored (understandably). Adding <para> elements doesn't help (in fact, it removed whitespace between paragraphs).

Perhaps a separate issue, but it'd be nice to use the <summary> section for the brief description, and the <remarks> section for more detailed information.
@jeredm
Copy link
Collaborator

@jeredm jeredm commented Mar 4, 2019

@jonsequitur I am wondering if we want Description in Symbol to be more complex object than a string. Changing to a complex object could have a large impact on unit tests. The help process assigns the XML document text to Description. Description is cleaned of new lines and whitespace and is finally split into lines to fit the screen. A more complex object would allow us to store lines of descriptions intentionally and <remarks>.

Another option would be to keep the <para> and <remarks> tags in the description and parse them out when the description is printed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area-DragonFruit Area-Help enhancement good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@drewnoakes @jonsequitur @jeredm