purescript-halogen-realworld icon indicating copy to clipboard operation
purescript-halogen-realworld copied to clipboard

Minor typography fixes

Open toastal opened this issue 2 years ago • 2 comments

Most of the README uses typographic apostrophes (aka “curly”). This commit fixes that one non-matching one. It also turns the -- into a proper em dash as Markdown unlike AsciiDoc doesn’t support this transformation by default.

toastal avatar Apr 01 '22 01:04 toastal

I think any incidence of a curly apostrophe is a mistake — I'd rather use normal ASCII, ie. '. Do you mind switching to that instead of the curly? Thanks for your recent fixup commits in this repo!

thomashoneyman avatar Apr 01 '22 15:04 thomashoneyman

I do not mind helping. It’s certainly your call. However, typographically the is more correct as the ' is a legacy thing with typewriters. Personally I feel it’s all arbitrary on what’s considered ‘easy to type’ as UK keyboards have issue with apply because $).

If you want your README to look ‘beautiful’ while maintaining ease of typing, AsciiDoc does text replacements. Bonuses include, proper titles for code blocks, no need to manually number ordered lists, admonitions (using a blockquote with > for “Alternately, …” is the wrong element).

toastal avatar Apr 01 '22 17:04 toastal