Skip to content

[#654] Explain absence of ToStorageType TAddress instance

Description

Problem: TAddress isn't intended to be a part of Cleveland API, but it is extensively used in older code. This can create an incentive to add a ToStorageType (TAddress a) instance as a quick fix. However, there isn't a valid use case for such an instance.

Solution: Add a Haddock comment explaining why there is no such instance and alternatives.

Related issue(s)

Resolves #654 (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.

N/A

Stylistic guide (mandatory)

Edited by Nikolay Yakimov

Merge request reports