Improve docs #52
Improve docs #52
Conversation
- Fix deprecated syntax [a] for Array a - Add a missing full stop
It confuses `psc-docs` and ends up stripping documentation. We should fix this in the compiler eventually.
|
I thought it would be good to add details of the instances because a) |
| @@ -1,7 +1,8 @@ | |||
| language: node_js | |||
| sudo: false | |||
| node_js: | |||
| - 0.10 | |||
| - 4.2 | |||
| - 5.2 | |||
There was a problem hiding this comment.
Is it worth just specifying 4 and 5 here so the latest point release of each is used?
There was a problem hiding this comment.
I wasn't aware you could do that! Definitely sounds sensible. Will do.
| at least one `true`. | ||
| * `Traversable`, which provides the PureScript version of a for-loop, | ||
| allowing you to iterate over an array and accumulate effects. | ||
|
|
There was a problem hiding this comment.
Sorry, had another thought. Perhaps we could make these link to the appropriate classes rather than having to include types, etc? Or maybe both if you think it's useful to include this info here as well.
There was a problem hiding this comment.
That [edit: linking] would be nice, but we'd have to choose a specific version of prelude/foldable-traversable to link to, which might cause problems if things change. These particular classes probably won't change that much, but other stuff in those packages might.
I had beginners in mind in particular with this paragraph, or rather, people who aren't yet familiar with all of these type classes. For example, I've encountered people more than once in IRC who were confused about why Data.Array doesn't have a function analogous to JS' Array.prototype.concat. So that's why I included this info here.
There was a problem hiding this comment.
Ah, ok. I kinda assumed you could leave the version out of the URL and it would redirect to the latest, the way it does for the package route. But that wouldn't help anyway if things moved around.
Makes sense.
There was a problem hiding this comment.
I think giving people a way of linking to a particular type in the documentation could be really nice, but I haven't quite figured out how to do it well just yet.
See the commit messages for a description of the changes.