Commit 589849f5 authored by Victor Poughon's avatar Victor Poughon

DOC: improve doc warnings

parent c18ecbad
import sys
import re
def parameter_warnings(app_warn, app, key):
......@@ -17,11 +18,13 @@ def parameter_warnings(app_warn, app, key):
if "." in name:
warn("name contains a special character (.)")
# disabled because there are so many for now
#if description == "":
#warn("missing description")
if len(description) > 0 and description[-1] != ".":
warn("description does not end with a period")
# disabled because there are so many for now
#if len(description) > 0 and description[-1] != ".":
#warn("description does not end with a period")
if len(description) > 0 and " :" in description:
warn("description has a space before a colon")
......@@ -38,7 +41,7 @@ def application_documentation_warnings(app):
if not longdescription[-1] == ".":
warn("Application Long Description does not end with a period (.)")
if "\n " in longdescription:
if re.search("\\n [a-zA-Z]", longdescription):
warn("Application Long Description contains '\\n ' pattern (usually not intended)")
if " :" in longdescription:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment