channable / hoff

A gatekeeper for your commits
Apache License 2.0
41 stars 3 forks source link

Add a link to the readme when reporting parse errors #269

Closed isomorpheme closed 4 weeks ago

isomorpheme commented 2 months ago

Resolves #261. I've decided to just add a (hard-coded) message linking to the syntax description in the readme; hard-coding a summarised description of the syntax might be nicer, but would essentially be duplication with the readme and risk getting out of sync. Ideally, the syntax description would be extracted from the parser, like what many CLI arg parsing libraries support, but that's not trivial, so leaving it to future work.

isomorpheme commented 4 weeks ago

@OpsBotPrime merge

OpsBotPrime commented 4 weeks ago

Pull request approved for merge by @isomorpheme, rebasing now.

OpsBotPrime commented 4 weeks ago

Rebased as 7aa6981e82d7e0d930d3b6824c387410f7159bfc, waiting for CI …

OpsBotPrime commented 4 weeks ago

CI job :yellow_circle: started.