Truncate help strings at "\f" characters, same as click

click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications

MIT License

212 stars 57 forks source link

Truncate help strings at "\f" characters, same as click #124

Closed nilsvu closed 1 year ago

nilsvu commented 1 year ago

Summary

Click truncates help strings at \f characters: https://click.palletsprojects.com/en/8.1.x/documentation/#truncating-help-texts

Tasks

[ ] Added unit tests
[ ] Added documentation for new features (where applicable)
[ ] Added release notes (using reno)
[ ] Ran test suite and style checks and built documentation (tox)

Further details

stephenfin commented 1 year ago

This is working as intended, as noted in https://github.com/click-contrib/sphinx-click/issues/56. If you actually want to respect the truncation then we can make it so but only if the user opts in. I'd be happy to review a PR that included a configuration option to enable this behavior (+ tests, docs, and a release note of course).

stephenfin commented 1 year ago

I'm going to close this for the interim, but please do reopen it if you're able to address the above.