-
Notifications
You must be signed in to change notification settings - Fork 97
Enhancements to Haddock -> Markdown conversion #344
Conversation
Any chance of some tests? I could imagine future changes breaking some of the more subtle bits. |
I can try, but I've already had the problem that the documentation from packages changes from version to version. I'm planning to have a look at #7 and #270, and then we can write tests which reference files in the project itself. |
I was thinking just a pure function, so take the Show of the DocH for unsafePerformIO as it stands today, paste it in as a test, and paste the current output as a string, and confirm that the conversion takes one to the other. |
That makes sense. I'll write some of them during the weekend. |
@ndmitchell the tests are in. Let me tell you what you think. Right now I've chosen two of the "hardest" ones: |
Tests look great! Thanks for doing that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 I pulled this on my local and I can verify that this fixes #341. Thank you, @serras. 💯
Still, adding some tests should be nice, as @ndmitchell suggested. If no similar tests are in place though, perhaps we should merge and add those separately.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Pushed a small change to make the tests a bit more readable.
* Enhancements to Haddock -> Markdown conversion * Add tests for Haddock -> Markdown conversion * Make HLint happy * Let Haddock tests compile also in 8.4 * Fix build for 8.4 * Fix test for haddock-library 1.8.0 * Fix CPP problem * Make tests a bit more readable Co-authored-by: Moritz Kiefer <[email protected]>
* Enhancements to Haddock -> Markdown conversion * Add tests for Haddock -> Markdown conversion * Make HLint happy * Let Haddock tests compile also in 8.4 * Fix build for 8.4 * Fix test for haddock-library 1.8.0 * Fix CPP problem * Make tests a bit more readable Co-authored-by: Moritz Kiefer <[email protected]>
* Enhancements to Haddock -> Markdown conversion * Add tests for Haddock -> Markdown conversion * Make HLint happy * Let Haddock tests compile also in 8.4 * Fix build for 8.4 * Fix test for haddock-library 1.8.0 * Fix CPP problem * Make tests a bit more readable Co-authored-by: Moritz Kiefer <[email protected]>
* Enhancements to Haddock -> Markdown conversion * Add tests for Haddock -> Markdown conversion * Make HLint happy * Let Haddock tests compile also in 8.4 * Fix build for 8.4 * Fix test for haddock-library 1.8.0 * Fix CPP problem * Make tests a bit more readable Co-authored-by: Moritz Kiefer <[email protected]>
Fixes #341