Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 of 5 tasks
nevrome opened this issue Mar 5, 2023 · 3 comments
Open
2 of 5 tasks

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

nevrome opened this issue Mar 5, 2023 · 3 comments
Labels
enhancement New feature or request for the future

Comments

@nevrome
Copy link
Member

nevrome commented Mar 5, 2023

  • Input test data preparation for the Golden tests
  • renderJannoCompleteness in Poseidon.CLI.Survey
  • 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 nevrome added enhancement New feature or request for the future labels Mar 15, 2023
@nevrome nevrome pinned this issue Apr 14, 2023
@nevrome nevrome unpinned this issue Jul 11, 2024
@nevrome
Copy link
Member Author

nevrome commented Jul 18, 2024

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
Copy link
Member

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
Copy link
Member Author

nevrome commented Jul 26, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request for the future
Projects
None yet
Development

No branches or pull requests

2 participants