docs D000 and D005 warnings

Bug #1777669 reported by Tom Barron
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
Fix Released
Low
Tom Barron

Bug Description

Running 'tox -edocs' yields:

...
build succeeded.
docs runtests: commands[2] | doc8 --ignore D001 --ignore-path .tox --ignore-path doc/build --ignore-path manila.egg-info -e txt -e rst
Scanning...
Validating...
/home/tbarron/Workspaces/manila/README.rst:39: D000 Bullet list ends without a blank line; unexpected unindent.
/home/tbarron/Workspaces/manila/README.rst:39: D005 No newline at end of file
========
Total files scanned = 173
Total files ignored = 2153
Total accumulated errors = 2
Detailed error counts:
    - CheckCarriageReturn = 0
    - CheckIndentationNoTab = 0
    - CheckMaxLineLength = 0
    - CheckNewlineEndOfFile = 1
    - CheckTrailingWhitespace = 0
    - CheckValidity = 1
ERROR: InvocationError: '/home/tbarron/Workspaces/manila/.tox/docs/bin/doc8 --ignore D001 --ignore-path .tox --ignore-path doc/build --ignore-path manila.egg-info -e txt -e rst'
_________________________________________________________________________________ summary __________________________________________________________________________________
ERROR: docs: commands failed

Tom Barron (tpb)
Changed in manila:
importance: Undecided → Low
assignee: nobody → Tom Barron (tpb)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (master)

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

Changed in manila:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.openstack.org/576554
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=30ab595ec7cd03157716889628d2c0c36f8c4cee
Submitter: Zuul
Branch: master

commit 30ab595ec7cd03157716889628d2c0c36f8c4cee
Author: Tom Barron <email address hidden>
Date: Tue Jun 19 11:08:58 2018 -0400

    Fix doc warnings

    Clean up D000 and D005 warnings on doc build.

    Closes-Bug: #1777669

    Change-Id: I3c059136850a15a823b7eff83c7837f55a09f734

Changed in manila:
status: In Progress → Fix Released
Tom Barron (tpb)
Changed in manila:
milestone: none → rocky-3
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 7.0.0.0b3

This issue was fixed in the openstack/manila 7.0.0.0b3 development milestone.

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.