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

game_design chapter edit suggestions #102

Merged
merged 1 commit into from
Mar 23, 2015

Conversation

synesthete
Copy link
Contributor

Clean up minor typos and reformatting, rewording for increased clarity.

Clean up minor typos and reformatting, rewording for increased clarity.
@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

@phoenixperry can you take a look at these changes, they seem good to me!

@bilderbuchi
Copy link
Member

I'm not sure I agree with changing all the apostrophes from apostrophe characters ' to this: .

@synesthete
Copy link
Contributor Author

The bulk of this chapter was with . I normalized the beginning and end to match.
Is there a preference one way or the other for standardizing this across the entirety of the book?

@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

I don't think we've ever standardized this, I'm fine with either, is there a reason not to use ’ (which is more typographically correct, I guess) ?

@bilderbuchi
Copy link
Member

one reason: how do you enter this? at least my keyboard only has a typewrite apostrophe key, and no typographic apostrophe key.

@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

@bilderbuchi
Copy link
Member

also, be aware that forward/backticks or prime characters are not the correct choices. whatever zach typed, from what i see, is a typhographic apostrophe. WP reference if you enjoy nerding out on typography. :-P :D

@synesthete
Copy link
Contributor Author

Generally I know my primes from forward/back ticks and typographic quotes. Inputting the typographic quotes is definitely more involved, but I think the payoff of a well-formatted document is worth the effort. I am happy to fix these up as I work my way through a complete read of the book. I can also circle back through the earlier chapters quickly.

@mikewesthad
Copy link
Member

If I'm remembering correctly, the typographic quote within a code block will break the latex parsing (via listings package, #69). I saw at least one example in the diff that might be a problem.

@bilderbuchi
Copy link
Member

tbh, I think it's more appropriate to fix this automatically during conversion/compiling, cause otherwise we'll end up with another inconsistent bunch of edits. This book being envisioned as a living document, we'll also most probably get PRs using the typewriter apostrophes.

Fwiw, for me personally (and as used in my chapter throughout), the typewriter apostrophes are the only practical option - it's a shift-key keystroke, where in contrast, I wouldn't even know how to enter a proper typographical apostrophe without consulting wikipedia et. al. I would guess that the majority of other contributors are in a similar situation.
Interesting tidbit, on my laptop keyboard, the key glyph for the typewrite apostrophe (shift-# on a german layout) is a typographical apostrophe (single closing quote, a little 6). :-P

@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

I think @mikewesthad and @bilderbuchi make good points, I know the latex parsing has been quite rough when it hits things it doesn't like, so maybe it makes sense to (as a general rule) avoid those characters in the text and to add them via something like http://smartquotesjs.com/

@mikewesthad
Copy link
Member

+1 to that

@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

ok here's a massive commit worth a solid look over -- I made a new branch to try to standardize this.

fc3d75a

done via
find . -type f -name '.md' -exec sed -i '' s/’/'/ {} +
find . -type f -name '
.md' -exec sed -i '' s/‘/'/ {} +

(note that should be *.md, gh is doing something strange with this code)

@mikewesthad
Copy link
Member

@ofZach, nice! Looks good to me. Seems like a few slipped under the radar somehow (e.g. this line)? The game design chapter was written in word (or something similar), so maybe something special is going in this chapter.

Should we do the same for double quotes? In skimming the commit, I saw that at least the installation_up_4evr_macosx chapter mixes " " and “ ” (with at least once case " ”).

@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

I think there's some caching issues maybe on the github diffs, as I think this is fixed. if I do this:

 grep '’' */*.md 
 grep '‘' */*.md

I'm not seeing anything. happy to attack the double quotes :)

@ofZach
Copy link
Contributor

ofZach commented Mar 22, 2015

ok pushed an attempt to rid of curly quotes

(sorry just to point out that this is a discussion of a different PR -- #118) not this PR 102...

@phoenixperry
Copy link
Contributor

I can sign off on these

phoenixperry pushed a commit that referenced this pull request Mar 23, 2015
game_design chapter edit suggestions merged!
@phoenixperry phoenixperry merged commit caf9e67 into openframeworks:master Mar 23, 2015
@bilderbuchi
Copy link
Member

wow, great effort, thanks!

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.

5 participants