Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Adds entry to style guide closes #2114
  • Loading branch information
JJ committed Jun 23, 2018
1 parent 009af0b commit 849f90c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions writing-docs/STYLEGUIDE.md
Expand Up @@ -45,6 +45,20 @@ so it's best to use it from the start.

## Language

### Unambiguous is better than short

When you have to choose between two sentence structures, opt for the
unambiguous.

```
my %hash = hash;
my @array = <1 2 3>
```

In this case, `this code initializes a hash` is short, but
ambiguous. Opt for `The first line of this example initializes an
empty hash`.

### 'say' vs 'put'

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

0 comments on commit 849f90c

Please sign in to comment.