Skip to content

documentation: provide some explanation of "case folding" #28

@robx

Description

@robx

I just spent quite a while digging, first through the source, finally ending up at http://hackage.haskell.org/package/text-1.2.4.0/docs/Data-Text.html#v:toCaseFold while trying to figure out what the result of toCaseFold is actually like.

It would probably be useful to others to do one or more of the following.

  • add a sentence in the general parts of the documentation noting that case folding is mostly but not quite lowercasing (perhaps with a link to a more detailed explanation)
  • in the documentation of foldedCase, explicitly state that the result depends on the FoldCase instance (instead of just a "see also")
  • document the behaviour of the individual FoldCase instances

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions