cylc-flow icon indicating copy to clipboard operation
cylc-flow copied to clipboard

Published 20 hours ago • verified publisher icon cylc

pyproject.toml: cylc lint settings

Open wxtim opened this issue 3 years ago • 9 comments

Closes #5052

Check List

  • [x] I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • [x] Contains logically grouped changes (else tidy your branch by rebase).
  • [x] Does not contain off-topic changes (use other PRs for other changes).
  • [x] Applied any dependency changes to both setup.cfg and conda-environment.yml - tomli used, because it will become the standard library's interface.
  • [x] Tests are included (or explain why tests are not needed).
  • [x] CHANGES.md entry included if this is a change that can affect users
  • [x] Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/531.

wxtim avatar Aug 18 '22 07:08 wxtim

Waiting for reviewers to check that I've not gone off at teh deep end prior to writing a documentation PR

wxtim avatar Aug 18 '22 08:08 wxtim

1 doctest failure

MetRonnie avatar Aug 22 '22 14:08 MetRonnie

Oops, tests/f/cylc-lint/01.lint-toml.t failing

MetRonnie avatar Aug 26 '22 15:08 MetRonnie

ignore = ['S008'] is now recognised but does not work

I can't replicate this - can you send me the toml file you are using - It took me a wee while to remember that my section heading was cylc-lint and not cylc_lint or cylclint. What do you think of testing for any of those?

wxtim avatar Sep 14 '22 07:09 wxtim

Just using

[cylc-lint]
    ignore = ['S008']

and having a line longer than the default 130

MetRonnie avatar Sep 14 '22 08:09 MetRonnie

It took me a wee while to remember that my section heading was cylc-lint and not cylc_lint or cylclint. What do you think of testing for any of those?

I think it's too much work to try and anticipate users' typos

MetRonnie avatar Sep 14 '22 08:09 MetRonnie

It took me a wee while to remember that my section heading was cylc-lint and not cylc_lint or cylclint. What do you think of testing for any of those?

I think it's too much work to try and anticipate users' typos

I see - I think I've fixed it

wxtim avatar Sep 14 '22 08:09 wxtim

Everythging seems to be working apart from ignoring S008. I suggest adding a test for that too

MetRonnie avatar Sep 14 '22 09:09 MetRonnie

Everythging seems to be working apart from ignoring S008. I suggest adding a test for that too

Reverted to draft - not priority this afternboon

wxtim avatar Sep 14 '22 11:09 wxtim