Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Adds an explanatory paragraph and closes #2115, which is the correct one
  • Loading branch information
JJ committed Jun 23, 2018
1 parent 849f90c commit 695771d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions writing-docs/STYLEGUIDE.md
Expand Up @@ -59,6 +59,12 @@ In this case, `this code initializes a hash` is short, but
ambiguous. Opt for `The first line of this example initializes an
empty hash`.

In general, try to put yourself in the shoes of someone with no
previous exposition to the language. Although it might seem obvious to
you that only the first line can in fact initialize a hash, the
documentation is targeted at people with no previous exposition to the
language.

### 'say' vs 'put'

While there is no hard and fast rule about which of these routines to use
Expand Down

0 comments on commit 695771d

Please sign in to comment.