"D001 Line too long" check for definition list term
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=
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://
description: | updated |
https:/ /review. openstack. org/271757/