First, thanks for your work.
I ask you to reconsider the feature introduced with PR #1081.
-
Adding a newline only to some options feels inconsistent and leads to a weird-looking "non-uniform" help strings. It's even worse when you use an extension that adds new help sections (e.g. Cloup for option groups), since some sections are not clearly demarked or too much demarked. It looks like a complete mess.
-
I'm pretty sure it's non-standard. Why should it be the default?
As a consequence, it feels like a bug. I did mistake it for a bug. Another developer reported it as a bug (issue #1559). The few people I asked don't like it and consider it a problem worth the effort of writing additional code to get rid of it. Most people in the original issue (#1075) are for an all-or-nothing behavior and described the current behviour as inconsistent as well.
Here's some alternative proposals.
- Remove the feature.
- Make it possible but non-default. Two solutions here:
- Add a parameter to
HelpFormatter. It can be made as simple as a boolean or as complex as a "list item separation strategy". A user can pass a custom factory function as Context.formatter_class (which probably could be called formatter_factory).
- Refactor
HelpFormatter to make it easy for people to override without copying, pasting and modiyfing the current code of HelpFormatter.write_dl.
Thank you again.
First, thanks for your work.
I ask you to reconsider the feature introduced with PR #1081.
Adding a newline only to some options feels inconsistent and leads to a weird-looking "non-uniform" help strings. It's even worse when you use an extension that adds new help sections (e.g. Cloup for option groups), since some sections are not clearly demarked or too much demarked. It looks like a complete mess.
I'm pretty sure it's non-standard. Why should it be the default?
As a consequence, it feels like a bug. I did mistake it for a bug. Another developer reported it as a bug (issue #1559). The few people I asked don't like it and consider it a problem worth the effort of writing additional code to get rid of it. Most people in the original issue (#1075) are for an all-or-nothing behavior and described the current behviour as inconsistent as well.
Here's some alternative proposals.
HelpFormatter. It can be made as simple as a boolean or as complex as a "list item separation strategy". A user can pass a custom factory function asContext.formatter_class(which probably could be calledformatter_factory).HelpFormatterto make it easy for people to override without copying, pasting and modiyfing the current code ofHelpFormatter.write_dl.Thank you again.