DeforaNetworks/pentext
3
0
Fork 0
Code Releases Activity

Adjust docstrings to 'official' Google format

Browse Source
This commit is contained in:
Peter Mosmans
2017-11-10 16:32:44 +10:00
parent 230283aa31
commit a8e7cc8ce1
1 changed files with 5 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
chatops/python/validate_report.py
View File

@@ -1,7 +1,6 @@
#!/usr/bin/env python #!/usr/bin/env python
""" """Cross-checks findings, validates XML files, offerte and report files.
Cross-checks findings, validates XML files, offerte and report files.
This script is part of the PenText framework This script is part of the PenText framework
https://pentext.org https://pentext.org
@@ -278,24 +277,18 @@ def abbreviations(word, **kwargs):
def capitalize(sentence): def capitalize(sentence):
""" """Return capitalized version of @sentence."""
Return capitalized version of @sentence
"""
return titlecase(sentence, callback=abbreviations) return titlecase(sentence, callback=abbreviations)
def is_capitalized(line): def is_capitalized(line):
""" """Check whether all words in @line start with a capital."""
Checks whether all words in @line start with a capital.
Returns True if that's the case.
"""
return not line or line.strip() == titlecase(line, callback=abbreviations).strip() return not line or line.strip() == titlecase(line, callback=abbreviations).strip()
def validate_type(tree, filename, options): def validate_type(tree, filename, options):
""" """Perform specific checks based on type.
Performs specific checks based on type.
Currently only finding and non-finding are supported. Currently only finding and non-finding are supported.
""" """
result = True result = True