List of code sections that should be refactored at some point

poseidon-framework / poseidon-hs

A toolset to work with modular genotype databases in the Poseidon format

https://poseidon-framework.github.io/#/trident

MIT License

7 stars 2 forks source link

List of code sections that should be refactored at some point #236

Open nevrome opened 1 year ago

nevrome commented 1 year ago

[x] Input test data preparation for the Golden tests
[x] renderJannoCompleteness in Poseidon.CLI.Survey
[x] The data types for .janno and .ssf should live in an own module
[ ] replace misused type class Show with an own class
[ ] Organize the defaultPackageReadOptions as considered here

nevrome commented 4 months ago

Here's a library tackling the Show issue identified above: https://github.com/haskell-text/text-display

The text-display library offers the Display typeclass for developers to print a textual representation of datatypes that does not have to abide by the rules of the Show typeclass.

stschiff commented 4 months ago

Ah cool. Do we have a specific list of data types in mind where we misuse the show class? Are we doing this wrong in every manual Show instance?

nevrome commented 4 months ago

A search for instance Show in the code base reveals many manually defined instances. I systematically misused the typeclass.