search

lijunle / Vsxmd

VS XML documentation -> Markdown syntax.
MIT License
215 stars 51 forks source link

Comma-separated parameter lists #78

Open FlushablPet opened 4 years ago

FlushablPet commented 4 years ago

Hi,

Thanks again for the Alpine build. I'm back, not a major bug, but with something that would improve readability of the end result. The list of parameter names for methods and constructors is comma-separated, but lacks a space after the comma. The impact of this is that the browser will not word-wrap the parameters, so it treats the list as a single word and run it off the page. Adding a space after the comma would make it word-wrap normally.

lijunle commented 4 years ago

Hi, @FlushablPet

Which part of list of parameter names do you refer? In the table of content or the body? How long is your method + parameter list?

FlushablPet commented 4 years ago

Hi,

I'm referring to the ctor(p1,p2,p3,p4) or method(p1,p2,p3,p4) shown in the content TOC, the h3 body headers for constructor and method items.

Some of the parameter lists are long/verbose, but particularly because they're headers, and hence larger text, it means they cause the page to overflow to the right especially on mobile browsers.

lijunle commented 4 years ago

Hmm... Adding space around the parentheses and after the comma should be fine. Let me experiment it later then get back.