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

Published 20 hours ago • verified publisher icon cylc

cfgspec: add link to cylc-doc entry in error messages

Open oliver-sanders opened this issue 3 years ago • 4 comments

For value-error type ParsecErrors it would be helpful to include a link to the documentation for the configuration that was mis-configured to save the user having to dig through the docs to find it.

Pull requests welcome!

oliver-sanders avatar Feb 08 '22 11:02 oliver-sanders

Do-able, the main issue is passing the corresponding item from the SPEC into the exception.

This commit is enough to derive the URL from the SPEC:

https://github.com/oliver-sanders/cylc-flow/pull/new/docs-url

oliver-sanders avatar Feb 18 '22 15:02 oliver-sanders

Any reason not to post that commit as a PR?

hjoliver avatar Feb 21 '22 21:02 hjoliver

Will look at this post 8.0.0 as it would require re-working exceptions so isn't a small change.

oliver-sanders avatar Feb 22 '22 09:02 oliver-sanders

Blocked by #4867

oliver-sanders avatar May 11 '22 16:05 oliver-sanders