Refactor.lint #5718
Merged
Refactor.lint #5718
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
Oct 30, 2023
There was a problem hiding this comment.
cylc-doc build error:
Warning, treated as error:
~/github/cylc-flow/cylc/flow/scripts/lint.py:docstring of cylc.flow.scripts.lint:10:Title underline too short.
`S001 <https://cylc.github.io/cylc-doc/stable/html/workflow-design-guide/style-guide.html#tab-characters>`_
^^^^
make: *** [html] Error 2
wxtim
force-pushed
the
refactor.lint
branch
2 times, most recently
from
cf5159a
to
641ec46
Compare
Refactored get_reference_rst and get_reference_text into a single method. Actually use the URL in rst reference mode Added urls to CLI linter listing move extraneous stuff away from main func added type hinting and removed toml merging routines from the top level functions Move the logic for checking if the target is a Cylc 8 workflow to its own function. We want the target to be the top level folder, not the flow.cylc file
MetRonnie
reviewed
Nov 20, 2023
MetRonnie
reviewed
Nov 22, 2023
Comment on lines
-1274
to
+1285
| __doc__ += TOMLDOC.format( | ||
| '\n\n.. code-block:: toml\n', str(LINT_SECTIONS)) + get_reference_rst( | ||
| parse_checks(['728', 'style'], reference=True)) | ||
| __doc__ += get_reference('all', 'rst') |
There was a problem hiding this comment.
Is this supposed to be
__doc__ += TOMLDOC.format(
'\n\n.. code-block:: toml\n', str(LINT_SECTIONS)
) + get_reference('all', 'rst')?
There was a problem hiding this comment.
Actually I think not, this was what is currently causing cylc-doc build failures but your changes fix it
There was a problem hiding this comment.
(Will need a fix backported to 8.2.x)
1 task
MetRonnie
approved these changes
Nov 22, 2023
markgrahamdawson
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: log_vc_info: handle long command output (cylc#5821) GH Actions: limit tutorial workflow to Py3.11 remove cylc task dependencies env var (cylc#5836) Refactor.lint (cylc#5718) protobuf 4.24.4 upgrade (cylc#5828) made reinstall work on multiple workflows Fix `IndepQueueManager` test (cylc#5832) Lint: Add a check for indentation being 4N spaces. (cylc#5772)
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.
I did a review of my older code as a training exercise, and started refactoring.
get_reference_textandget_reference_rst.There's plenty more refactoring I'd like to do, but I really shouldn't be prioritizing this.
Check List
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfg(andconda-environment.ymlif present).CHANGES.mdentry included if this is a change that can affect users?.?.xbranch.