Add Haddock documentation and further types #6322
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
Renames the `ExtraGlobal` data constructor of `InstalledPackageLocation` as `ExtraPkgDb`. Provides types `PackageDatabase` and `PackageDbVariety`. The former replaces the use of `Maybe (InstalledPackageLocation, Path Abs Dir)`, where `Nothing` was used to represent the global package database (now there is data constructor `GlobalPkgDb`). The latter replaces the use of `Maybe InstalledPackageLocation`, where `Nothing` was also used to represent the global package database (now there is data constructor `GlobalDb`). Also updates and corrects existing Haddock documentation. For example `Sink` is deprecated as a type synonym.
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.
Renames the
ExtraGlobaldata constructor ofInstalledPackageLocationasExtraPkgDb.Provides types
PackageDatabaseandPackageDbVariety. The former replaces the use ofMaybe (InstalledPackageLocation, Path Abs Dir), whereNothingwas used to represent the global package database (now there is data constructorGlobalPkgDb). The latter replaces the use ofMaybe InstalledPackageLocation, whereNothingwas also used to represent the global package database (now there is data constructorGlobalDb).Also updates and corrects existing Haddock documentation. For example
Sinkis deprecated as a type synonym.Please also shortly describe how you tested your change. Bonus points for added tests! Relying on CI.