checkniceness should skip max_length check for code-blocks in a list

Bug #1487302 reported by Sam Stoelinga on 2015-08-21
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
doc8
Undecided
Sam Stoelinga
openstack-manuals
Undecided
Sam Stoelinga

Bug Description

Currently if a codeblock is inside an unordered list it checkniceness complains when a line exceeds 80 characters. A code-block should be allowed to have a line exceeding 80 characters.

Steps to reproduce:

This is an unoredered list:

- Hello there

  .. code-block:: ini
     this line will exceed 80 characters but should not be reported by checkniceness as it's inside a code block..........

Current result:
checkniceness fails with D001 Line too long

Expected result:
Checknicess succeeds with no errors reported

Currently affected patch by this behaviour: https://review.openstack.org/#/c/213985/

This should be fixed upstream in https://pypi.python.org/pypi/doc8

description: updated
description: updated
description: updated
Changed in openstack-manuals:
assignee: nobody → Sam Stoelinga (sammiestoel)
Andreas Jaeger (jaegerandi) wrote :

This needs to be fixed in doc8.

Changed in doc8:
assignee: nobody → Sam Stoelinga (sammiestoel)

Reviewed: https://review.openstack.org/215685
Committed: https://git.openstack.org/cgit/stackforge/doc8/commit/?id=64f22e443f826c040a0783535667b20c0919f7a6
Submitter: Jenkins
Branch: master

commit 64f22e443f826c040a0783535667b20c0919f7a6
Author: Sam Stoelinga <email address hidden>
Date: Fri Aug 21 23:16:53 2015 +0800

    Fix issue of checking max_len for directives

    This patch changes the regex to also match directives
    which start with whitespace.

    Closes-Bug: #1487302

    Change-Id: I4c3168228164d865cc31dfd24160c41267aeb016

Changed in doc8:
status: New → Fix Committed
Lana (loquacity) on 2015-09-21
Changed in openstack-manuals:
status: New → Fix Released

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

Changed in doc8:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Duplicates of this bug

Other bug subscribers