Skip to content

Removed passive voice from 7 examples #163

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

Merged
merged 1 commit into from
May 25, 2017

Conversation

budziq
Copy link
Collaborator

@budziq budziq commented May 25, 2017

  • Generate random numbers within a range
  • Generate random numbers with normal distribution
  • Generate random values of a custom type
  • Encode a string as application/x-www-form-urlencoded
  • Remove fragment identifiers and query pairs from a URL
  • Make a HTTP GET request
  • Download a file to a temporary directory

Connected with: https://github.com/brson/rust-cookbook/issues/139

Copy link
Member

@dtolnay dtolnay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done! This is a great improvement.

As you do the rest of these, pay attention to how the beginning of each sentence provides information that immediately puts the remainder of the sentence in context. Here is an analysis of one from this PR. Notice how the new sentence is clear because you understand the significance of each piece as you read it, while the old sentence is unclear because you need to read until the very end to find out what the sentence is trying to say.

Before

A tuple `(i32, bool, f64)`—I don't know what this example is about
and variable—still don't know
of user defined type—doesn't the user define the type of all variables?
`Point` are—more like "get to the point," am I right?
randomly generated—oh so it randomly generates things

After

Randomly generates—ok this example is about randomly generating something
a tuple `(i32, bool, f64)`—makes sense, this is what it generates
and variable of user defined type—neat, not limited to generating builtin types
`Point`—key thing to look for in the code

@dtolnay dtolnay merged commit a61085f into rust-lang-nursery:master May 25, 2017
@budziq budziq deleted the passive_voice branch June 7, 2017 07:44
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.

2 participants