Update library to Contributors library standards#16
Conversation
|
Confirmed that Once this PR gets merged I'll add issues for the following outstanding items:
|
|
|
||
| 1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer-types). | ||
| 2. Written documentation is kept in the [docs directory](./docs). | ||
| 3. Usage examples can be found in [the test suite](./test). |
There was a problem hiding this comment.
We can remove parts of this section which aren't relevant for a library (for example, this one doesn't have tests and so we should remove that line. It probably doesn't need a docs directory, either).
There was a problem hiding this comment.
Other than that, this looks good!
There was a problem hiding this comment.
Alright, I removed the docs directory and the references to docs and test in the README.
| @@ -25,8 +25,6 @@ The quick start hasn't been written yet (contributions are welcome!). The quick | |||
| `arraybuffer-types` documentation is stored in a few places: | |||
|
|
|||
| 1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer-types). | |||
There was a problem hiding this comment.
Given there is only one of these left, what if we just merge this with the prior sentence? Then there would be no numbered list.
“Module documentation for arraybuffer-types ...”
There was a problem hiding this comment.
I merged the sentences per your suggestion.
I also cleaned up another spot that was referring to the docs directory.
This PR updates
purescript-arraybuffer-typesto adhere to the Contributors library guidelines.This is part of the purescript-contrib/governance#13 effort.