click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Add whitespace to option choice separator to allow wrapping #64

Closed timabrmsn closed 4 years ago

timabrmsn commented 4 years ago

For choice lists that end up being long (due to many available choices or the length of choice names), having the separator be just a | with no whitespace forces the choices to always be on a single line, which can force it outside the border of the doc.

This change turns this: no_whitespace_example Into this: whitespace_example

stephenfin commented 4 years ago

I'll get this in a release shortly. Thanks!