openstack/hacking
Code Issues Proposed changes

Cleanup some docstrings.

Browse Source 
Change-Id: I5df869ec2eda6d3cd5dd26d940cc74b1d209c7f6
Reviewed-on: https://review.openstack.org/30816
Reviewed-by: Sean Dague <sean@dague.net>
Approved: Joe Gordon <joe.gordon0@gmail.com>
Reviewed-by: Joe Gordon <joe.gordon0@gmail.com>
Tested-by: Jenkins
This commit is contained in:
David Ripton 2013-05-28 21:49:24 -04:00 committed by Jenkins
parent 1a96383ff5
commit df809dfda1
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
hacking/core.py
View File

@ -280,6 +280,7 @@ def hacking_import_alphabetical(logical_line, blank_lines, previous_logical,
def is_docstring(physical_line, previous_logical):
"""Return True if found docstring
'A docstring is a string literal that occurs as the first statement in a
module, function, class,'
http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring
@ -298,7 +299,7 @@ def is_docstring(physical_line, previous_logical):
@flake8ext
def hacking_docstring_start_space(physical_line, previous_logical):
r"""Check for docstring not start with space.
r"""Check for docstring not starting with space.
OpenStack HACKING guide recommendation for docstring:
Docstring should not start with space
@ -598,7 +599,7 @@ class OnceGitCheckCommitTitleBug(GitCheck):
"""Check git commit messages for bugs.
OpenStack HACKING recommends not referencing a bug or blueprint in first
line, it should provide an accurate description of the change
line. It should provide an accurate description of the change
H801
"""
name = "GitCheckCommitTitleBug"