Skip to content

Commit 6ff67a4

Browse files
authored
Fix bad TOML example in cylc lint docstring (#5843)
1 parent b96a4d0 commit 6ff67a4

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

cylc/flow/scripts/lint.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
TOMLDOC = """
4141
pyproject.toml configuration:{}
4242
[cylc-lint] # any of {}
43-
ignore = ['S001', 'S002] # List of rules to ignore
43+
ignore = ['S001', 'S002'] # List of rules to ignore
4444
exclude = ['etc/foo.cylc'] # List of files to ignore
4545
rulesets = ['style', '728'] # Sets default rulesets to check
4646
max-line-length = 130 # Max line length for linting
@@ -1286,6 +1286,4 @@ def main(parser: COP, options: 'Values', target=None) -> None:
12861286

12871287
# NOTE: use += so that this works with __import__
12881288
# (docstring needed for `cylc help all` output)
1289-
__doc__ += TOMLDOC.format(
1290-
'\n\n.. code-block:: toml\n', str(LINT_SECTIONS)) + get_reference_rst(
1291-
parse_checks(['728', 'style'], reference=True))
1289+
__doc__ += get_reference_rst(parse_checks(['728', 'style'], reference=True))

0 commit comments

Comments
 (0)