Skip to content

[#157] Build typedoc reference base on `typeDocName`

Moremi Vannak requested to merge rinn7e/#157-use-typedocname into master

Description

Problem: Related to the instance of TypeHasDoc, when there are serveral types with the same name, even if we assign typeDocName differently, typeDocMdReference still refer to the same type name. For example typeDocName: Bar Dog and Baz Dog, they still have typeDocMdReference as the same Dog. The current workaround is to specify customTypeDocMdReference manually.

Solution: build homomorphicTypeDocMdReference which is used by typeDocMdReference as reference to typeDocName, so that we will not have to manually specify customTypeDocMdReference.

Related issue(s)

Resolved #157 (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 Moremi Vannak

Merge request reports