Add xml-conduit docs to Hackage

[ndmitchell]

Not having them on Hackage makes the beginner experience significantly worse.

[ndmitchell]

I'm reporting this issue, but it was raised to me by an upset beginner.

[ndmitchell]

This was made worse because Name doesn't link through to xml-types, so it's hard to figure out what it does, and the Eq information is very important, specifically looking at the source is required.

[snoyberg]

Was this thread related by any chance? https://www.reddit.com/r/haskell/comments/572qch/public_service_announcement_you_can_use_stackage/

My strong recommendation to everyone is to just use stackage.org for the docs, which actually build reliably, e.g.:

https://www.stackage.org/package/xml-conduit

It's definitely a weird quirk of Haddock that it won't link to the Name type in the original package due to the reexport, however the docs do mention the somewhat surprising instance's behavior:

When comparing names with Eq or Ord methods, prefixes are ignored.

[ndmitchell]

This thread was entirely unrelated to that. It was a beginner at work who raised it to me.

The surprising Eq for Name is called out, but while it says prefixes are ignored, it doesn't make it clear if namespaces (e.g. the bit implied by the prefix) is ignored or not. Saying the equality operates over those two fields and ignores the third would have been clearer. It also doesn't have examples of what Name values look like, so as someone with less familiarity with XML, I had to resort to a bit of Show to figure out what went where.

[snoyberg]

I'm not disagreeing that having a nice Source link would be better in this case. And the docs for Name could certainly be improved with these ideas, I just don't have the ability to do so in this repo.

[ndmitchell]

Understood - I wasn't sure if Name would have been hyperlinked to the source if it had been on Hackage, which is why I brought it up. I'll probably pull-request xml-types with the doc clarifications that would have been useful and would have meant I didn't want to look at the source code.

[ndmitchell]

As it happens, xml-types is not on github, which unfortunately puts the barrier to me contributing too high 😞