Docs are not up to date on Pursuit

[jmatsushita]

The pursuit docs for singleton show a codePointFromInt function which has been removed from the API a while back, and in fact the docs are properly updated in the source code: https://github.com/purescript/purescript-strings/blob/master/src/Data/String/CodePoints.purs#L84

[JordanMartinez]

I believe you can push these docs yourself.

[jmatsushita]

Hi @JordanMartinez I gave this a shot (in fact live on stream so you can check it out at https://twitch.tv/junxan) but couldn't do it yet. Maybe you can orient me to the next steps?

I noticed v4.0.2 wasn't up on pursuit (and I can't build master as I don't have purescript 0.14 installed), so I checked out that tag. I was able to build, and generate docs locally with:

npx purs docs "src/**/*.purs" "bower_components/*/src/**/*.purs" --format html

I also logged in via pulp login but pulp publish --no-push failed with:

repository urls did not match.
* Repository url in your bower.json file:
*   git://github.com/purescript/purescript-strings.git
* Repository url in the registry:
*   https://github.com/purescript/purescript-strings.git
* Please make sure these urls match.

I made a local commit to change the bower.json file and had to retag as v4.0.2 and got pulp to respond:

Checking your package is registered in purescript/registry... ok
Publishing purescript-strings at v4.0.2. Is this ok? [y/n]

I'm feeling a bit uneasy with publishing from detached head and breaking people's code. I couldn't find a way to only publish docs.

Hope you can help me get unstuck!

[JordanMartinez]

Looks like you should use toEnum now. CodePoint must lie within a valid range. Also, when Pursuit is out-of-date, you can use Starsuit, which shows documentation for the latest package set.

[thomashoneyman]

Hi @jmatsushita! Thanks for taking the time to try and publish this library. We're unfortunately in a transitional period wrt packaging and library publishing, which is why you're running into issues. Typically, as @JordanMartinez mentioned, anyone can upload documentation for a library using pulp publish --no-push on the tag that's missing upstream.

Right now, you're having an issue because we're switching from Bower for our registry to our own PureScript registry (https://github.com/purescript/registry). Bower files which are using git://github.com/... have to be updated to use https://github.com/... so that the documentation can be published. This is an irritating state of affairs, but soon the documentation on Pursuit will be automatically pulled from the registry, and so it'll automatically be up to date and no one will have to push documentation in the first place 💯

For the time being I'd recommend using Starsuit like @JordanMartinez suggested, or generating the documentation locally if you need it for a particular tag and it's not available on Pursuit. This is just a temporary measure -- in the future you'll be able to see up-to-date versions of docs across the ecosystem on Pursuit.

We're about to make a round of releases across the core libraries so we'll make sure the docs are up to date at the same time.

[jmatsushita]

Thanks for the explanation, it makes a lot of sense and I can use Starsuit for now. Good luck with the transition!