"D001 Line too long" check for definition list term

Bug #1533238 reported by KATO Tomoyuki
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
doc8
Fix Released
Undecided
KATO Tomoyuki

Bug Description

From Sphinx docs, the definition list term cannot have more than one line of text [1].
On the other hand, we sometimes need to use the long term in the definition lists.
So, I think we should skip "D001 Line too long" check for definition list term.

-- example --
``--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>``
  Create a NIC on the server. Specify option multiple
  times to create multiple NICs. Either net-id or port-
  id must be provided, but not both. net-id: attach NIC
  to network with this UUID, port-id: attach NIC to port
  with this UUID, v4-fixed-ip: IPv4 fixed address for
  NIC (optional), v6-fixed-ip: IPv6 fixed address for
  NIC (optional).
--

[1] http://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-like-blocks

description: updated
Revision history for this message
KATO Tomoyuki (kato-tomoyuki) wrote :
Changed in doc8:
assignee: nobody → KATO Tomoyuki (kato-tomoyuki)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to doc8 (master)

Reviewed: https://review.openstack.org/271757
Committed: https://git.openstack.org/cgit/openstack/doc8/commit/?id=a96c31fb3ebfda69bd4149aff6dbcf2d0013dd3e
Submitter: Jenkins
Branch: master

commit a96c31fb3ebfda69bd4149aff6dbcf2d0013dd3e
Author: KATO Tomoyuki <email address hidden>
Date: Sun Jan 24 22:12:57 2016 +0900

    Skip long line check for rst definition list term

    Change-Id: Ieb272e506034eac7129c24ee0e0fbc40b55d11b1
    Closes-Bug: #1533238

Changed in doc8:
status: In Progress → Fix Released
Revision history for this message
Davanum Srinivas (DIMS) (dims-v) wrote : Fix included in openstack/doc8 0.7.0

This issue was fixed in the openstack/doc8 0.7.0 release.

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.