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

Improve english & re-vamp whole book #47

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Zagita21
Copy link

@Zagita21 Zagita21 commented Jul 9, 2023

Thanks for making this guide! While going through trying to understand, having many German friends I recognised instantly some of the odd use of English, and in fact a lot of the difficulties in understanding it came from some issues in the language, in addition to some errors and other issues. I therefore did a wholesale revamp of the book while going through it (which took much longer than expected)

general improvements & corrections:
Main objective was to make this easier to read and understand, to correct the grammatical errors and to make the English sound more natural.

  • Germanglish -> English ;) (eg "Hopefully, ..." -> "Thankfully, ...", excessive use of commas and long incomprehensible sentences, odd Deutsch-sounding turns of phrase or just incorrect grammar or punctuation, inconsistent tenses, incorrect or awkward use of this/that would/will, "nevermore" etc. etc.)
    e.g. (from before edit)
    "Now let's take a look at handling results with 2-4 options. It is actually
    interesting, that using 2, even if the transaction is performed by sub-call
    succeed, we may now take a look at the data it returned with Reply, and on
    its final state after it finished, and we can still decide, that act as a
    whole is a failure, in which case everything would be rolled back - even
    currency transfer performed by external contract."
    Totally incomprehensible ;)

  • changed to gender-neutral where unnecessary to specify

  • unnecessary repetitive language (sometimes) removed (eg "As mentioned before..." )

  • removed inconsistencies in use of I/we (chose the less egotistic version to go with). This is probably the most "opinionated" change, but I think it makes it less weird to read.

  • I mostly ignored the over-use (and often incorrect use) of hypenation (-), assuming it is stylistic, except where it was painful. Also left in some anachronisms which nevertheless allow character of the author to pass through

  • I also noticed that there is quite a bit of repetition in the second part of the book, almost as if two separate documents were pulled together? Anyway, of course I just corrected it as it is (and was useful to have the review on the topics anyway :) )

  • of course it is possible that some small gremlins crept in, but I did two passes and it is in my opinion a much improved script

I do believe the result is much easier to read and understand, which will mean it is more accessible, so I hope it is helpful, and thanks again for sharing your deep knowledge and skills with us! :)

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.

1 participant