-
Notifications
You must be signed in to change notification settings - Fork 743
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
Polish English Tutorial #37
base: master
Are you sure you want to change the base?
Conversation
Add `.editorconfig` and `.gitattributes` settings to enforce code styles consistency across different editors and IDEs.
@lotabout, here's my contribution to your great project, by polishing up the English text. Before going ahead with the remaining tutorial chapters, let me first know if my contribution plays out well with you. If you do confirm, I'll go ahead and polish the other chapters too. You wrote:
Not being able to read the original text in Chinese, I've done my best to adapt the text to its general context, trying to polish it and flesh it out so that it would be smoother to read.
Feel free to drop some questions in this PR thread, e.g. asking why I changed a sentence in a given way, etc. I'll be happy to reply to the best of my knowledge and ability. |
Question About an Ambiguous Sentence@lotabout, I have a question about th paragraph in the Before you go section:
I wasn't sure whether you meant:
Not being sure, I took the safe approach and stuck to (2), which is closer to the current text; but somehow, I have the gut feeling that you really meant (1) — if that's the case, I can rephrase that sentence and force-push the commit, before merging (or rebasing) the PR (rebasing seems a better option, since there are two commits in this PR, for it would keep history linear). |
@tajmone Thanks for the careful proofreading.
What I want to say is: Though building a compiler/interpreter could be fun and self-accomplishment, it's a hard process because:
So, I hope readers not to be too optimistic and aware the obstacles ahead the road. But of cause it's worth the effort. |
Then that sentence is good as it is. Feel free to merge/rebase the PR: |
94b1c11
to
eed9483
Compare
I've combined the fixes to "1. Skeleton" with the last commit and forced pushed, so we can reduce the number of commits (but I've kept the EditorConfig commit separate, for it deals with different changes). |
eed9483
to
a77ef6d
Compare
21b3b34
to
839dd2f
Compare
Polish the English text of every tutorial chapter, and Improve markdown source docs: * Add Level 1 title to docs ("Preface", "1. Skeleton", etc.). * Replaces smiles with markdown emojis. * Fix titles casing using Chicago Manual of Style capitalization rules: https://capitalizemytitle.com/style/chicago# * Convert inline-link to reference-style links (DRY!). * Add a few links to external references.
839dd2f
to
53518b7
Compare
OK, I've finished polishing all the chapters. Feel free to merge if there's no more reviewing needed. |
Polish the English text of every tutorial chapter, and Improve markdown source docs:
https://capitalizemytitle.com/style/chicago#
.editorconfig
and.gitattributes
settings to enforce code styles consistency across different editors and IDEs.