[OpenStack-docs] RST line length

Andreas Jaeger aj at suse.com
Fri Jun 12 14:02:31 UTC 2015


On 06/12/2015 03:36 PM, Anne Gentle wrote:
>
>
> On Fri, Jun 12, 2015 at 8:28 AM, Andreas Jaeger <aj at suse.com
> <mailto:aj at suse.com>> wrote:
>
>     On 06/12/2015 08:16 AM, Andreas Jaeger wrote:
>
>         On 06/12/2015 12:55 AM, Meg McRoberts wrote:
>
>             checkniceness seems to complain about any line longer than
>             69 chars --
>             perhaps coded as <70?  It's been kind of arbitrary about
>             when Jenkins
>             does a
>             failure -- subtleties of which I'm not aware, it seems, but
>             once it does
>             a FAILURE
>             for a CR, it's adamant about wanting it fixed ;-)
>
>
>         The current limit should be 79 characters for RST files (that's
>         doc8's
>         default), if it's not we can change it to use that value (or any
>         other
>         as desired).
>
>
>     First cleanup patch:
>     https://review.openstack.org/191067
>
>     If you want to help, just change the value in tox.ini and fix files.
>
>
> Thanks Andreas - I just commented on the patch that I want us to avoid
> tables when possible, especially two-column ones that can be written as
> definition lists. Tables are not always the right answer for information
> and when they're difficult to create and maintain I think it's a better
> choice to use another format when we can.


Good idea, updated,

Andreas
-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Dilip Upmanyu, Graham Norton,
        HRB 21284 (AG Nürnberg)
     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list