Line length validation issue for code-block content in bulleted list

Bug #1515377 reported by Matt Kassawara
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Confirmed
Medium
Unassigned

Bug Description

The 'checkniceness' job that uses doc8 has a problem with line length of code-block content within a bulleted list. Using a numbered list resolves the problem. For example, from the neutron-verify-option1.rst file in the installation guide:

Passes checkniceness:

#. List agents to verify successful launch of the neutron agents:

   .. code-block:: console

      $ neutron agent-list
      +--------------------------------------+--------------------+------------+-------+----------------+---------------------------+
      | id | agent_type | host | alive | admin_state_up | binary |
      +--------------------------------------+--------------------+------------+-------+----------------+---------------------------+
      | 08905043-5010-4b87-bba5-aedb1956e27a | Linux bridge agent | compute1 | :-) | True | neutron-linuxbridge-agent |
      | 27eee952-a748-467b-bf71-941e89846a92 | Linux bridge agent | controller | :-) | True | neutron-linuxbridge-agent |
      | dd3644c9-1a3a-435a-9282-eb306b4b0391 | DHCP agent | controller | :-) | True | neutron-dhcp-agent |
      | f49a4b81-afd6-4b3d-b923-66c8f0517099 | Metadata agent | controller | :-) | True | neutron-metadata-agent |
      +--------------------------------------+--------------------+------------+-------+----------------+---------------------------+

Fails checkniceness:

* List agents to verify successful launch of the neutron agents:

  .. code-block:: console

     $ neutron agent-list
     +--------------------------------------+--------------------+------------+-------+----------------+---------------------------+
     | id | agent_type | host | alive | admin_state_up | binary |
     +--------------------------------------+--------------------+------------+-------+----------------+---------------------------+
     | 08905043-5010-4b87-bba5-aedb1956e27a | Linux bridge agent | compute1 | :-) | True | neutron-linuxbridge-agent |
     | 27eee952-a748-467b-bf71-941e89846a92 | Linux bridge agent | controller | :-) | True | neutron-linuxbridge-agent |
     | dd3644c9-1a3a-435a-9282-eb306b4b0391 | DHCP agent | controller | :-) | True | neutron-dhcp-agent |
     | f49a4b81-afd6-4b3d-b923-66c8f0517099 | Metadata agent | controller | :-) | True | neutron-metadata-agent |
     +--------------------------------------+--------------------+------------+-------+----------------+---------------------------+

doc/install-guide/source/neutron-verify-option1.rst:13: D001 Line too long
doc/install-guide/source/neutron-verify-option1.rst:14: D001 Line too long
doc/install-guide/source/neutron-verify-option1.rst:15: D001 Line too long

Tags: doc-tools
Changed in openstack-manuals:
assignee: nobody → venkatamahesh (venkatamaheshkotha)
Changed in openstack-manuals:
importance: Undecided → Medium
status: New → Confirmed
Revision history for this message
KATO Tomoyuki (kato-tomoyuki) wrote :

I wonder if why line 13, 14, 15 is too long, but line 12 is okay.

Changed in openstack-manuals:
assignee: venkatamahesh (venkatamaheshkotha) → nobody
Changed in openstack-manuals:
assignee: nobody → venkatamahesh (venkatamaheshkotha)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

Fix proposed to branch: master
Review: https://review.openstack.org/261511

Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on openstack-manuals (master)

Change abandoned by venkatamahesh (<email address hidden>) on branch: master
Review: https://review.openstack.org/261511

Changed in openstack-manuals:
assignee: venkatamahesh (venkatamaheshkotha) → nobody
status: In Progress → Confirmed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.