Doc patch: link to ShortByteString from ByteString module

[ulidtko]

Greetings all

Per the closed discussion in #193 — code-change won't be happening, but documentation may get improved.

Here I'm submitting a paragraph near the top of Data.ByteString module reiterating the points made in Data.ByteString.Short section on memory fragmentation. The idea is to simply advertise ShortByteString from the package entry-point.

Having been caught in this caveat myself — I can definitely reflect that the mention of ShortByteString from package header (cabal description), was hard to notice.

@Bodigrim please review? Wording nitpicks, feedback, etc — totally welcome. Would appreciate an approve to merge, thanks in advance.

[clyring]

I like the general idea. I'll try to leave some wordsmithery comments in the next day or two.

[ulidtko]

Hi @clyring, thanks for review. Suggestions taken, patch amended with rewords.

[clyring]

Sorry for the high latency on this round of review.

[ulidtko]

No worries at all @clyring, thanks for getting back on this, appreciate the thoroughness.

I'd responded in comments trying to clarify, and remain open for further suggestions.

It's overall an intricate topic, but I think the docs here shouldn't elaborate all related technicalities; what remains is necessarily vague hinting at ideas, search keywords and such. I'll readily admit it's a fine balance, and won't dispute your perspective on which way to tilt it. So, by all means, smash the word anvil 😃 as you see fit.

[ulidtko]

Took another stab at it, amended with minor tweaks + rebased onto latest master.