Skip to content

Should the docs mention instances for base? #98

@andreasabel

Description

@andreasabel

I was searching for an instance of Arbitrary (Data.List.NonEmpty.NonEmpty _), i.e., a type defined in base, and looked up the docs for this package.

This package provides instances for the classes in the QuickCheck Haskell library.
QuickCheck itself doesn't ship with instances for types outsde of the `base` package, however there are a lot more types which are commonly used within Haskell libraries and programs.
We aim to provide instances for the types which ship with the Haskell Platform, however we only add them as the maintainer needs them or as patches are received, so we may lag behind the platform itself.

Instances are provided for the types in the packages:
* array
* bytestring
* case-insensitive

It does not say (yet) that it provides instance for base.
This might be documentation bit-rot, since originally non-empty lists were not part of base.

I think README and docs should be updated to reflect the current situation.

Maybe also this sentence:

Patches are always welcome!

See also:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions