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

Allow adding missing .. code-block:: bash on examples where its simple to do so

Browse source
This commit is contained in:
Pedro Algarvio 2021-02-10 11:24:33 +00:00 • committed by Megan Wilhite
parent 2c973716c1
commit 06e111ff0a
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
tasks/docstrings.py
View file

@ -190,11 +190,17 @@ def _autofix_docstring(docstring):
def _fix_simple_cli_example_spacing_issues(docstring):
cli_example_regex = re.compile(
case_and_spacing_regex = re.compile(
r"CLI Example(?P<plural>s)?(?:[\s]+)?:(?:[^\n]+)?(?:[\n]+)",
flags=re.I | re.MULTILINE,
)
return cli_example_regex.sub(r"CLI Example\1:\n\n", docstring)
missing_code_block_regex = re.compile(
r"\n([ ]+)CLI Example(?P<plural>s)?:\n\n([\s]+)salt ", flags=re.I | re.MULTILINE
)
return missing_code_block_regex.sub(
r"\n\1CLI Example\2:\n\n\1..code-block:: bash\n\n\3salt ",
case_and_spacing_regex.sub(r"CLI Example\1:\n\n", docstring),
)
def _fix_directives_formatting(docstring):