saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Catch some more badly formatted version added/changed/deprecated directives

Browse source
This commit is contained in:
Pedro Algarvio 2021-02-11 06:47:32 +00:00 • committed by Megan Wilhite
parent 241f677fff
commit 9e1b51478c
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
tasks/docstrings.py
View file

@ -195,7 +195,7 @@ def _autofix_docstring(docstring):
def _convert_version_names_to_numbers(docstring):
directive_regex = re.compile(
".. ((?P<vtype>(versionadded|versionchanged|deprecated)):: (?P<version>.*))"
".. ((?P<vtype>(versionadded|versionchanged|deprecated))(?:[:]+)(?:[ ]+)?(?P<version>.*))"
)
for match in directive_regex.finditer(docstring):
vtype = match.group("vtype")
@ -213,7 +213,7 @@ def _convert_version_names_to_numbers(docstring):
pass
parsed_versions.append(vs)
replace_contents = ".. {}:: {}".format(vtype, ", ".join(parsed_versions))
docstring = docstring.replace(match.group(0), replace_contents)
docstring = docstring.replace(match.group(0), replace_contents.rstrip())
return docstring
@ -233,20 +233,19 @@ def _fix_simple_cli_example_spacing_issues(docstring):
def _fix_directives_formatting(docstring):
directive_regex = re.compile(
r"^(?P<spc1>[ ]+)?((?P<dots>[.]{2,})(?P<spc2>[ ]+)?(?P<directive>([^ ]{1}).*))::(?P<remaining>.*)\n$"
r"(\n(?P<spc1>[ ]+)?((?P<dots>[.]{2,})(?P<spc2>[ ]+)?(?P<directive>(?:[^ :]+)))(?:[:]{2})(?P<spc3>[ ]+)?(?P<remaining>[^\n]+)?\n)"
)
output = []
for line in docstring.splitlines(True):
match = directive_regex.match(line)
if match:
line = "{}.. {}:: {}".format(
for match in directive_regex.finditer(docstring):
replacement = (
"\n{}.. {}:: {}".format(
match.group("spc1") or "",
match.group("directive"),
match.group("remaining").strip(),
match.group("remaining") or "",
).rstrip()
line += "\n"
output.append(line)
return "".join(output)
+ "\n"
)
docstring = docstring.replace(match.group(0), replacement)
return docstring
def _fix_codeblocks(docstring):