Skip to content

Update syntax.adoc - fix typo "machine-readable" #468

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

Closed
wants to merge 1 commit into from

Conversation

NReilingh
Copy link

@NReilingh NReilingh commented Jul 2, 2020

Missing the word "machine" -- pretty sure this was the intention.

  • Have you read the guidelines for contributing?
  • Have you signed the Clojure Contributor Agreement?
  • Have you verified your asciidoc markup is correct?
Missing the word "machine" -- pretty sure this was the intention.
@puredanger
Copy link
Member

Thanks for the report. Actually, the intent here is to refer to the Clojure "reader" (https://clojure.org/reference/reader) so I think it should stand as is.

@puredanger puredanger closed this Jul 2, 2020
@NReilingh
Copy link
Author

So... it's supposed to be a pun on "human-readable and reader-readable", instead of writing "human- and reader-readable"?

Even if that's the case, I'd suggest finding a better way to present that, since that sentence doesn't parse as written. Usage of a hanging hyphen requires that you join to the base word at the end, and the best a reader's eye can do with this sentence is interpret the space after readable- to be a mistake, parsing as human-printing and readable-printing, which doesn't really make sense semantically.

puredanger added a commit that referenced this pull request Jul 2, 2020
@puredanger
Copy link
Member

Ok, I've revised several references in that text to better describe printing for human consumption vs readable data.

@NReilingh NReilingh deleted the patch-1 branch July 2, 2020 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants