You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just might be missing something obvious but is there a way to reformat text to wrap it to some appropriate length? I currently have to do that manually as our build system uses doc8 to lint and has line length restrictions enabled.
Important note on line length linters: Limiting line length in prose text and documentation is not a smart idea. If you are just writing plain docs by hand (for Sphinx!) simply ignore these limits and switch your editor to word wrap instead.
It is much better to write one sentence or semantic block per line.
If your documentation or string is inline in your code and exceeds the limits this is a challenge for static code analysers. Here you get the arguments why it is worth to ignore PEP8 here.
If you change prose over time rearranging word wrap in human readable text to match e.g. PEP8 80 chars per line can and will lead to unreadable diffs. and clunky source code.
Another point is that gnu gettext based translation of docs (which you can use excellently with sphinx-intl) leads to cleaner message ids and reuse of standard phrases. It makes the life of translators much easier.
Creating exceptions to make linters ignore i18n message ids ist not the topic of this comment.
I just might be missing something obvious but is there a way to reformat text to wrap it to some appropriate length? I currently have to do that manually as our build system uses doc8 to lint and has line length restrictions enabled.
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
The text was updated successfully, but these errors were encountered: