Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 6475b5e

Browse files
shairezwardbell
authored andcommitted
docs(style-guide): added the one more why on 02-02
closes #1473
1 parent 990a80e commit 6475b5e

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

public/docs/ts/latest/guide/style-guide.jade

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,27 +193,33 @@ a(href="#toc") Back to top
193193

194194
.s-rule.do
195195
:marked
196-
**Do** use dashes to separate words.
196+
**Do** use dashes to separate words in the descriptive name.
197197

198198
.s-rule.do
199199
:marked
200200
**Do** use dots to separate the descriptive name from the type.
201201

202202
.s-rule.do
203203
:marked
204-
**Do** use consistent names for all components following a pattern that describes the component's feature then its type. A recommended pattern is `feature.type.ts`.
204+
**Do** use consistent type names for all components following a pattern that describes the component's feature then its type. A recommended pattern is `feature.type.ts`.
205205

206206
.s-rule.do
207207
:marked
208-
**Do** use conventional suffixes for the types including `*.service.ts`, `*.component.ts`, `*.pipe.ts`. Invent other suffixes where desired, but take care in having too many.
208+
**Do** use conventional type names including `.service`, `.component`, `.pipe`.
209+
Invent additional type names if you must but take care not to create too many.
209210

210211
.s-why
211212
:marked
212-
**Why?** Provides a consistent way to quickly identify what is in the file.
213+
**Why?** Type names provide a consistent way to quickly identify what is in the file.
213214

214215
.s-why
215216
:marked
216-
**Why?** Provides a consistent way to quickly find a specific file using an editor or IDE's fuzzy search techniques.
217+
**Why?** Make it easy to find a specific file type using an editor or IDE's fuzzy search techniques.
218+
219+
.s-why
220+
:marked
221+
**Why?** Unabbreviated type names such as `.service` are descriptive and unambiguous.
222+
Abbreviations such as `.srv`, `.svc`, and `.serv` can be confusing.
217223

218224
.s-why.s-why-last
219225
:marked

0 commit comments

Comments
 (0)