documentation

documentation copied to clipboard

Add links to original papers/discussions behind PS features

2

I recently have become interested in the history of the "type class" concept. Wadler has a [type classes page](http://homepages.inf.ed.ac.uk/wadler/topics/type-classes.html) on his website which lists all the major type class-related papers...

chexxor

Rewrite the "Custom Type Errors" guide for 0.12

5

Based on the changes added here: https://github.com/purescript/purescript/pull/3298 Roughly: - New `Doc` kind - `TypeConcat` -> `Beside` - `TypeString` -> `Quote` - Symbol literal in message -> `Text` - New vertical...

LiamGoodacre

It's an old feature, but this was never added to this repo https://github.com/paf31/24-days-of-purescript-2016/blob/master/23.markdown

justinwoo

Include unicode escape sequence in docs on String literal

4

I had to look into PureScript source code and test cases to learn how to input Unicode characters by code points like this. At the same time, it might also...

chexxor

Improve docs about in-comment documentation syntax

1

It looks like the [language/Syntax #comments](https://github.com/purescript/documentation/blob/master/language/Syntax.md#comments) doc page doesn't mention the syntax of the documentation string itself. The PureScript compiler's source code references a "cheapskate" library, which is likely [jgm/cheapskate](https://github.com/jgm/cheapskate)....

chexxor

Document pattern-matching do-notation bindings

1

https://github.com/purescript/documentation/blob/master/language/Syntax.md#do-notation The "do notation" documentation doesn't mention that pattern-matching the bound value is possible, but it should.

chexxor

Document the language grammar in full

11

Copied from https://github.com/purescript/roadmap/issues/50

paf31

Document how constraints affect instance selection

1

It sounds like type class constraints might not affect instance selection. We should confirm that claim and add to the "language/Type-Classes.md" document. Claimed here: https://purescript-users.ml/t/type-class-that-has-a-monoid-instance-seems-to-require-all-instances-to-also-be-monoids/101/8 I'm also curious about this...

chexxor

There are a few gotchas. E.g. ```yaml dist: trusty sudo: required ``` is necessary to improve build time. (Full discussion https://github.com/purescript/purescript/issues/1880) Where should this be documented?

adius

Warning pages/skeletons all labelled as error

3

All pages under errors/ appear (at a random sample) to be titled *`SomeIssue` Error* I propose those which are warnings rather than errors should be titled *`SomeIssue` Warning*

nwolverson