doc8 icon indicating copy to clipboard operation
doc8 copied to clipboard

Add --allow-long-tables option to permit wide RST tables

Open lukelbd opened this issue 4 years ago • 2 comments

I often have very long tables that cannot be shortened and raise line-too-long doc8 errors. For example:

=======================  ======================================================================================================        
Header                   Description
=======================  ======================================================================================================        
Rather long header item  My very extremely long-winded wordy verbose descriptive supercalifragilisticexpialidocious description
=======================  ======================================================================================================        

doc8 has an --allow-long-titles option to prevent line-too-long errors for verbose titles. Could you also add an option to ignore line-too-long errors for very long tables?

lukelbd avatar Jun 21 '20 00:06 lukelbd

Or even just always allow RST tables to be long since they can't always be shortened?

fiendish avatar Jul 17 '20 18:07 fiendish

Hi, if this project is still maintained, and nobody is working on this, please could I take this issue on for Hacktoberfest 2021? If so, I can put up a PR shortly and definitely by the end of this week, to ignore .rst tables (in either the 'grid' or 'simple' form) in the maximum line length check. Thanks.

sadielbartholomew avatar Oct 25 '21 00:10 sadielbartholomew