Skip to content

[#747] Add errorDocArg, deprecate errorDoc

Nikolay Yakimov requested to merge lierdakil/#747-error-doc-arg into master

Description

Problem: errorDoc hard-codes error argument to '()'. This is not always desirable and arguably not even a sensible default since the introduction of 'NoErrorArg' in #383 (closed).

Solution: To avoid introducing hard-to-catch backwards compatibility issues, define a new quasi-quoter, 'errorDocArg' that allows specifying the type of the error argument as an optional parameter. Define 'errorDoc' in terms of 'errorDocArg'. Deprecate 'errorDoc'.

Related issue(s)

Resolves #747 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Nikolay Yakimov

Merge request reports