remove module description comment block #144
Merged
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
Barely any of the information it provided was useful. * 'Module' was redundant with the module name. * 'License' was redundant with the cabal 'license' field. * 'Maintainer' was incorrect (see #143). * 'Stability' doesn't really mean anything, and I haven't tried to update that field to reflect how likely I am to break the API. I try not to make gratuitiously-breaking changes, and I'll follow the PVP if I do decide that breaking backwards-compatibility is worth it. This leaves two fields, 'Portability' and an anonymous field for the module description: Portability : non-portable (GHC API) A Haskell interpreter built on top of the GHC API * 'Portability' means different things to different people. Hint is portable across operating systems, but not across different GHC versions. I like that the 'Portability' field explains exactly in which way the package is non-portable. The same information is available from the package summary. * The module description was describing the package, not the module, and so was redundant with the cabal 'summary' field. I like its wording better than the current summary ("Runtime Haskell interpreter (GHC API wrapper)"), so I've moved it to the cabal file.
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.
Barely any of the information it provided was useful.
This leaves two fields, 'Portability' and an anonymous field for the module description:
Fixes #143