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

Always include a blank line before CLI Example:

Browse source
This commit is contained in:
Pedro Algarvio 2021-02-10 18:16:06 +00:00 • committed by Megan Wilhite
parent 7bb8989ab8
commit 241f677fff
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
tasks/docstrings.py
View file

@ -219,7 +219,7 @@ def _convert_version_names_to_numbers(docstring):
def _fix_simple_cli_example_spacing_issues(docstring):
case_and_spacing_regex = re.compile(
r"CLI Example(?P<plural>s)?(?:[\s]+)?:(?:[^\n]+)?(?:[\n]+)",
r"(?:[\n]+)([ ]+)CLI Example(?P<plural>s)?(?:[\s]+)?:(?:[^\n]+)?(?:[\n]+)",
flags=re.I | re.MULTILINE,
)
missing_code_block_regex = re.compile(
@ -227,7 +227,7 @@ def _fix_simple_cli_example_spacing_issues(docstring):
)
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),
case_and_spacing_regex.sub(r"\n\n\1CLI Example\2:\n\n", docstring),
)