Fix.bad toml example in lint docstring #5843
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MetRonnie
reviewed
Nov 23, 2023
There was a problem hiding this comment.
On master you removed TOMLDOC from being appended to the docstring
cylc-flow/cylc/flow/scripts/lint.py
Lines 1275 to 1277 in 31150c9
This makes sense to me as it seems a bit out of place appearing in the docs like this:
Note that it still appears in the --help text as that is done separately
There was a problem hiding this comment.
Did we have this discussion before? I'm not sure that I really wanted to do that. Or did we agree to put the Toml reference somewhere else. Perhaps it could do with a new page somewhere?
There was a problem hiding this comment.
There is already a section on pyproject.toml at the bottom
wxtim
force-pushed
the
fix.bad_toml_example_in_lint_docstring
branch
from
31150c9 to
0991c63
Compare
MetRonnie
approved these changes
Nov 23, 2023
wxtim
added a commit
to wxtim/cylc
that referenced
this pull request
Dec 5, 2023
…at_runtime * upstream/master: tui: avoid deprecated import (cylc#5858) Exclude broken pytest-asyncio version remove lint (cylc#5856) Async pipe decorator: preserve wrapped func signature Maintain order for CYLC_PYTHONPATH (cylc#5853) Update tests/integration/tui/conftest.py tests/i: fix flaky tui/test_updater tests (cylc#5849) tests/i: tui - attempt to stabilise tests Bump pypa/gh-action-pypi-publish from 1.8.10 to 1.8.11 (cylc#5851) tests/i: fix flaky tui/test_updater tests Improve changelog entries Fix bad TOML example in `cylc lint` docstring (cylc#5843) lint - S011 no longer warns against 0{{a}} (cylc#5841) `cylc lint`: add rule to catch `rose date` tui: show view tui: log view tui: tidy dangling interfaces tui: fix an obscure freezing issue tui: update screenshots Tui 1.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Very small change to make Cylc Doc build correctly.