Skip to content

Commit dfe99a5

Browse files
committed
Use reference links instead of inline for clarity
1 parent 8af15e9 commit dfe99a5

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

_includes/sqlstyle.guide.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Overview
44

5-
You can use this set of guidelines, [fork them](#) or make your own - the
5+
You can use this set of guidelines, [fork them][fork] or make your own - the
66
key here is that you pick a style and stick to it. To suggest changes
7-
or fix bugs please open an [issue](#) or [pull request](#) on Git Hub.
7+
or fix bugs please open an [issue][] or [pull request][pull] on Git Hub.
88

99
## General
1010

@@ -32,7 +32,7 @@ SELECT first_name
3232

3333
### Reserved words
3434

35-
Always use uppercase for the [reserved keywords](#reserved-keyword-reference)
35+
Always use uppercase for the [reserved keywords][reserved-keywords]
3636
like `SELECT` and `WHERE`.
3737

3838
It is best to avoid the abbreviated keywords and use the full length ones where
@@ -50,14 +50,14 @@ SELECT model_num
5050
### White space
5151

5252
To make the code easier to read it is important that the correct compliment of
53-
spaces is used. Do not crowd code or remove natural language spaces.
53+
spacing is used. Do not crowd code or remove natural language spaces.
5454

5555
#### Spaces
5656

5757
Spaces should be used to line up the code so that the root keywords all end on
58-
the same character boundary. This forms a river down the middle make it easy for
58+
the same character boundary. This forms a river down the middle making it easy for
5959
the readers eye to scan over the code and separate the keywords from the
60-
implementation detail.
60+
implementation detail. Rivers are [bad in typography][rivers], but helpful here.
6161

6262
```sql
6363
SELECT f.average_height, f.average_diameter
@@ -149,7 +149,7 @@ SELECT r.last_name,
149149
### General
150150

151151
* Ensure the name is unique and does not exist as a
152-
[reserved keyword](#reserved-keyword-reference)
152+
[reserved keyword][reserved-keywords]
153153
* Keep the length to a maximum of 30 bytes—in practice this is 30 characters
154154
unless you are using multibyte charset
155155
* Names must begin with a letter and may not end with an underscore
@@ -1063,3 +1063,11 @@ YEAR_MONTH
10631063
ZEROFILL
10641064
ZONE
10651065
```
1066+
1067+
[issue]: #
1068+
[fork]: #
1069+
[pull]: #
1070+
[rivers]: http://practicaltypography.com/one-space-between-sentences.html
1071+
"Practical Typography: one space between sentences"
1072+
[reserved-keywords]: #reserved-keyword-reference
1073+
"Reserved keyword reference"

0 commit comments

Comments
 (0)