Skip to content

Commit 695771d

Browse files
committed
Adds an explanatory paragraph and closes #2115, which is the correct one
1 parent 849f90c commit 695771d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

writing-docs/STYLEGUIDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ In this case, `this code initializes a hash` is short, but
5959
ambiguous. Opt for `The first line of this example initializes an
6060
empty hash`.
6161

62+
In general, try to put yourself in the shoes of someone with no
63+
previous exposition to the language. Although it might seem obvious to
64+
you that only the first line can in fact initialize a hash, the
65+
documentation is targeted at people with no previous exposition to the
66+
language.
67+
6268
### 'say' vs 'put'
6369

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

0 commit comments

Comments
 (0)