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 syntax for the first part of the notebook #52

Merged
merged 1 commit into from
Aug 27, 2018

Conversation

m3at
Copy link
Contributor

@m3at m3at commented Aug 27, 2018

@keisuke-umezawa I only reviewed the first part (a bit more than what is visible on the blog post). Some feedback on what I corrected that might help you:
Specific examples:

  • No need to capitalize everything in a title
  • "I will explain" or "we will see", not "we will explain" (consistent point of view)
  • Mixing between for/with/into/of/from. Prefer a specific verb when possible (ex: using instead of with)
  • "in full scratch way" -> "from scratch", this is an idiom
  • "Roughly summarizing the contents" -> "Summary", the meaning of the world is already that
  • Don't use conditionals when it's not needed, "should" -> "will"
  • Unecessary "the" here and there (ex: "we use the images from", "the" isn't needed)

Globally:

  • Less is more, shorter sentences are better. You sometimes try to make overly-complicated sentences.
  • No need to restate the context too often (ex: "in this notebook")
  • If you're unsure, use simple words.

@keisuke-umezawa
Copy link
Member

@m3at Thank you so much!!!! Nice advices for me!

@keisuke-umezawa keisuke-umezawa merged commit 35b2734 into chainer-community:master Aug 27, 2018
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