Skip to content

Add documentation to `Lorentz.Ext`

Konstantin Ivanov requested to merge martoon/ext-docs into master

Description

Problem: this module is not documented.

If we are going to bring Lorentz to the masses, it would be nice if there is no need for people to guess the meaning of the methods or find it anywhere else.

Also, as my personal preference I'd like to outline that in stackType it is possible to omit non-significant parts of type, this feature seems to be underestimated.

Solution: add documentation.

Related issue(s)

Resolves #

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)

Merge request reports