diff --git a/public/docs/ts/latest/guide/style-guide.jade b/public/docs/ts/latest/guide/style-guide.jade index ab9922c1b6..f70308cc5d 100644 --- a/public/docs/ts/latest/guide/style-guide.jade +++ b/public/docs/ts/latest/guide/style-guide.jade @@ -193,7 +193,7 @@ a(href="#toc") Back to top .s-rule.do :marked - **Do** use dashes to separate words. + **Do** use dashes to separate words in the descriptive name. .s-rule.do :marked @@ -201,19 +201,25 @@ a(href="#toc") Back to top .s-rule.do :marked - **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`. + **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`. .s-rule.do :marked - **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. + **Do** use conventional type names including `.service`, `.component`, `.pipe`. + Invent additional type names if you must but take care not to create too many. .s-why :marked - **Why?** Provides a consistent way to quickly identify what is in the file. + **Why?** Type names provide a consistent way to quickly identify what is in the file. .s-why :marked - **Why?** Provides a consistent way to quickly find a specific file using an editor or IDE's fuzzy search techniques. + **Why?** Make it easy to find a specific file type using an editor or IDE's fuzzy search techniques. + +.s-why + :marked + **Why?** Unabbreviated type names such as `.service` are descriptive and unambiguous. + Abbreviations such as `.srv`, `.svc`, and `.serv` can be confusing. .s-why.s-why-last :marked