Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor typography fixes #109

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

toastal
Copy link
Contributor

@toastal toastal commented Apr 1, 2022

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.

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.
@thomashoneyman
Copy link
Owner

thomashoneyman commented Apr 1, 2022

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!

@toastal
Copy link
Contributor Author

toastal commented Apr 1, 2022

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants