Open Stack

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 afailure -- subtleties of which I'm not aware, it seems, but once it does a FAILUREfor a CR, it's adamant about wanting it fixed ;-)
meg

 
      From: Lana Brindley <openstack at lanabrindley.com>
 To: Meg McRoberts <dreidellhasa at yahoo.com>; "openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org> 
Cc: Radoslaw Smigielski <radoslaw.smigielski at alcatel-lucent.com> 
 Sent: Thursday, June 11, 2015 3:49 PM
 Subject: Re: [OpenStack-docs] RST line length
   
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 12/06/15 08:43, Meg McRoberts wrote:
> The conventions (https://wiki.openstack.org/wiki/Documentation/Markup_conventions#Avoid_long_lines)specify a maximum 70 characters per line; currently, checkniceness balks at anything longer than 69 chars.
> I think the recommendation should be 80 chars rather than 70 -- it just seems more "natural" somehowand is still short enough for gerrit displays.

Hrm, I don't remember noticing that before. I have my editor set at 78
chars, which so far hasn't caused a problem. I'm happy to see the
recommendation changed to 80.


> Personally, I favor short lines, broken along natural semantic boundaries (sentences, clauses) rather thanusing the vi facility to just wrap the text arbitrarily but that may be too much for some people.
> checkniceness does allow for programlistings/screens and URLs but it doesn't differentiate tables and I'mnot sure it can.  For this reason, I propose that the checkniceness limit be expanded, perhaps to 100.  Asan example, check the table in this section:
> https://review.openstack.org/#/c/188974/8/doc/ha-guide/source/networking-ha-l3.rst

What is it currently, do you know?



> The first column has some long strings that shouldn't be broken, so I ended up with a third column of 2-4 words,which is annoying and would make it impossible to put a URL or even a full pathname in that column.Worse, after I made these changes, the column widths in the formatted table are not correct -- the first columnends up being much wider than is necessary and the third column has pretty much the very short lines that arein the source.
> In the aforementioned CR, look at patch 5 or earlier to see this table before I had to redo it to placatecheckniceness.  
> 
> Other opinions?Meg
> 
> 
> 
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 


- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVehBiAAoJELppzVb4+KUynp8IALqA7GPJO+8cbu2Eez0ooPTI
PCkPKU4Nv0TNkWls0DwYwOFPgWlVmjn+pqn+NFt9RmiA1NWVO7QHlUXI9tqjAbVO
gH88YytskiTt9ifm8XJGAhx+lZADmRqMCGVji5gZFYO9QfDqTjTqw2KnkEE3FHxu
14LUqtFlZFn54q9caD7X5bo1ZZBWuWiI/iO5hsu8GDBJmH/Ko6U48zEQ1/sXGw33
zU1ws7wt44FK/qbS4x8qZwjkgGZ0kwXoBkWEJjP9XSqa2vSYD9UNQxK0yDdhBNRQ
X1GYwIKgJS3VzlN9K+1+rFt+chdeJN5/+ObnsUBMZV9P1/iovT0QY1sk0F40FWQ=
=9A9d
-----END PGP SIGNATURE-----


   
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150611/c32645a7/attachment.html>