Cleaning up, adjusting some demos and documentation #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- solving most hlint hints (learning something by the way) - rewrote some code mostly based on hlint suggestions - removed (or commented out) some dead code - fixed demos which where not working anymore - corrected some docs (hopefully accurate enough)
|
BTW: I added |
After preparing a Stack based build I found that TCache.hs didn't compile anymore. This is related to Haskell2010 vs Haskell98. I made (indentation) changes so it does compiles again.
|
I also needed to change formatting slightly to make it compile as Haskell2010. |
- Using "package.yaml" instead of cabal file (but keeping file locations unchanged for this branch) - compiles with -Wall with no warnings. Notice: I couldn't get rid of some orphan instaces and disabled warnings for those files (for now). - extened and clarified some of the demos. - combined some information from old cabal file to README.md and created a new ChageLog.md file. - added an unfinished directory for the WIP (or abandonded) CollectionStream.hs. - made "buildDemos.sh" more reliable. This will be replaced by a pseudo test suite in the future. - Bumped the version to 0.13 (to make it possible to select the older version for comparisons. But I am thinking of some breaking changes too, because I really don't like some of the name shadowing (esp. "key"). But that may go away with qualified imports. Dunno.
|
So I was curious what happens when I enable -Wall and went all the way down into this rabbit hole, finally getting it (mostly) clean. I think I strife to follow https://kowainik.github.io/posts/2019-02-06-style-guide for our own projects and try to move TCache a bit into that direction too. |
|
Looks good Thanks!. I will look at it in detail at the beginning of the next week |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
P.S.: In the next step I want to move everything to stack / package.yaml based build, make the demos into true targets and start to write some tests and fixing/rearrange some of the docs.