From cd970c21adcd0a045c35897f127ee9f339ada62d Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 15 Jun 2016 10:49:42 -0700 Subject: [PATCH 1/2] docs(toh-3/dart): copyedits and new snake_case glossary entry (#1629) --- .../toh-3/dart/lib/app_component.dart | 18 +++++----- .../docs/_examples/toh-3/dart/lib/hero.dart | 1 - .../toh-3/dart/lib/hero_detail_component.dart | 33 +++++++++---------- public/docs/dart/latest/glossary.jade | 14 +++++++- public/docs/dart/latest/tutorial/toh-pt1.jade | 3 +- public/docs/dart/latest/tutorial/toh-pt2.jade | 1 + public/docs/dart/latest/tutorial/toh-pt3.jade | 23 ++++++++----- public/docs/ts/latest/glossary.jade | 19 ++++++----- 8 files changed, 63 insertions(+), 49 deletions(-) diff --git a/public/docs/_examples/toh-3/dart/lib/app_component.dart b/public/docs/_examples/toh-3/dart/lib/app_component.dart index 774f8e68f6..d2ed99d75b 100644 --- a/public/docs/_examples/toh-3/dart/lib/app_component.dart +++ b/public/docs/_examples/toh-3/dart/lib/app_component.dart @@ -10,7 +10,7 @@ import 'hero_detail_component.dart'; @Component( selector: 'my-app', -// #docregion hero-detail-template + // #docregion hero-detail-template template: '''

{{title}}

My Heroes

@@ -23,8 +23,9 @@ import 'hero_detail_component.dart'; ''', -// #enddocregion hero-detail-template - styles: const [''' + // #enddocregion hero-detail-template + styles: const [ + ''' .selected { background-color: #CFD8DC !important; color: white; @@ -73,17 +74,16 @@ import 'hero_detail_component.dart'; } ''' ], -// #docregion directives - directives: const [ - HeroDetailComponent - ]) -// #enddocregion directives + // #docregion directives + directives: const [HeroDetailComponent] + // #enddocregion directives + ) class AppComponent { final String title = 'Tour of Heroes'; final List heroes = mockHeroes; Hero selectedHero; - onSelect(Hero hero) { + void onSelect(Hero hero) { selectedHero = hero; } } diff --git a/public/docs/_examples/toh-3/dart/lib/hero.dart b/public/docs/_examples/toh-3/dart/lib/hero.dart index 71eb336b9c..ea51fc9bc2 100644 --- a/public/docs/_examples/toh-3/dart/lib/hero.dart +++ b/public/docs/_examples/toh-3/dart/lib/hero.dart @@ -5,4 +5,3 @@ class Hero { Hero(this.id, this.name); } -// #enddocregion diff --git a/public/docs/_examples/toh-3/dart/lib/hero_detail_component.dart b/public/docs/_examples/toh-3/dart/lib/hero_detail_component.dart index e8481c5261..9b85d21965 100644 --- a/public/docs/_examples/toh-3/dart/lib/hero_detail_component.dart +++ b/public/docs/_examples/toh-3/dart/lib/hero_detail_component.dart @@ -11,29 +11,26 @@ import 'hero.dart'; // #docregion v1 @Component( selector: 'my-hero-detail', -// #enddocregion v1 + // #enddocregion v1 // #docregion template template: ''' -
-

{{hero.name}} details!

-
{{hero.id}}
-
- - -
-
- ''' +
+

{{hero.name}} details!

+
{{hero.id}}
+
+ + +
+
''' // #enddocregion template -// #docregion v1 + // #docregion v1 ) class HeroDetailComponent { -// #enddocregion v1 -// #docregion inputs + // #enddocregion v1 + // #docregion inputs @Input() -// #docregion hero + // #docregion hero Hero hero; -// #enddocregion hero -// #enddocregion inputs -// #docregion v1 + // #enddocregion hero, inputs + // #docregion v1 } -// #enddocregion v1 diff --git a/public/docs/dart/latest/glossary.jade b/public/docs/dart/latest/glossary.jade index ec8bdf04f3..4dad0d501e 100644 --- a/public/docs/dart/latest/glossary.jade +++ b/public/docs/dart/latest/glossary.jade @@ -12,7 +12,19 @@ include _util-fns !=partial('../../ts/latest/_fragments/glossary-f-l') !=partial('../../ts/latest/_fragments/glossary-m1') //!=partial('../../ts/latest/_fragments/glossary-m2') not needed in dart -!=partial('../../ts/latest/_fragments/glossary-n-s') +!=partial('../../ts/latest/_fragments/glossary-n-s-1') + +:marked + ## snake_case +.l-sub-section + :marked + The practice of writing compound words or phrases such that each word is separated by an underscore (`_`). + + Library and file names are often spelled in snake_case. Examples include: `angular2_tour_of_heroes` and `app_component.dart`. + + This form is also known as **underscore case**. + +!=partial('../../ts/latest/_fragments/glossary-n-s-2') !=partial('../../ts/latest/_fragments/glossary-t1') //!=partial('../../ts/latest/_fragments/glossary-t2') notneeded in dart !=partial('../../ts/latest/_fragments/glossary-u-z') diff --git a/public/docs/dart/latest/tutorial/toh-pt1.jade b/public/docs/dart/latest/tutorial/toh-pt1.jade index a600cea7d6..6c86b4d6ae 100644 --- a/public/docs/dart/latest/tutorial/toh-pt1.jade +++ b/public/docs/dart/latest/tutorial/toh-pt1.jade @@ -26,10 +26,9 @@ include ../_util-fns .children .file index.html .file main.dart + .file styles.css .file pubspec.yaml -// Add .file styles.css - .p   .callout.is-helpful diff --git a/public/docs/dart/latest/tutorial/toh-pt2.jade b/public/docs/dart/latest/tutorial/toh-pt2.jade index 6127079ab1..5fe537ddbc 100644 --- a/public/docs/dart/latest/tutorial/toh-pt2.jade +++ b/public/docs/dart/latest/tutorial/toh-pt2.jade @@ -29,6 +29,7 @@ p Run the #[+liveExampleLink2('', 'toh-2')] for this part. .children .file index.html .file main.dart + .file styles.css .file pubspec.yaml :marked ### Keep the app compiling and running diff --git a/public/docs/dart/latest/tutorial/toh-pt3.jade b/public/docs/dart/latest/tutorial/toh-pt3.jade index 3c4a961b77..25653aff27 100644 --- a/public/docs/dart/latest/tutorial/toh-pt3.jade +++ b/public/docs/dart/latest/tutorial/toh-pt3.jade @@ -21,12 +21,13 @@ p Run the #[+liveExampleLink2('', 'toh-3')] for this part. .children .file index.html .file main.dart + .file styles.css .file pubspec.yaml :marked ### Keep the app compiling and running We want to start the Dart compiler, have it watch for changes, and start our server. We'll do this by typing -code-example(format="." language="bash"). +code-example(language="bash"). pub serve :marked @@ -50,7 +51,7 @@ code-example(format="." language="bash"). ### Separating the Hero Detail Component Add a new file named `hero_detail_component.dart` to the `lib` folder and create `HeroDetailComponent` as follows. -+makeExample('toh-3/dart/lib/hero_detail_component.dart', 'v1', 'hero_detail_component.dart (initial version)')(format=".") ++makeExample('toh-3/dart/lib/hero_detail_component.dart', 'v1', 'lib/hero_detail_component.dart (initial version)')(format=".") .l-sub-section :marked ### Naming conventions @@ -61,7 +62,8 @@ code-example(format="." language="bash"). All of our component names end in "Component". All of our component file names end in "_component". - We spell our filenames in lower underscore case (AKA "snake_case") so we don't worry about + We spell our filenames in lower **underscore case** + (AKA **[snake_case](../guide/glossary.html#!#snake_case)**) so we don't worry about case sensitivity on the server or in source control. diff --git a/public/docs/_examples/lifecycle-hooks/e2e-spec.ts b/public/docs/_examples/lifecycle-hooks/e2e-spec.ts index ec6f5a5b4b..5bb55f9318 100644 --- a/public/docs/_examples/lifecycle-hooks/e2e-spec.ts +++ b/public/docs/_examples/lifecycle-hooks/e2e-spec.ts @@ -74,15 +74,15 @@ describe('Lifecycle hooks', function () { expect(titleEle.getText()).toContain('Windstorm-foo- can sing'); return changeLogEles.count(); }).then(function (count) { - // two more for each keystroke except the 1st - expect(count).toEqual(logCount + 9, 'should add 9 more messages'); + // one more for each keystroke + expect(count).toEqual(logCount + 5, 'should add 5 more messages'); logCount = count; // return powerInputEle.sendKeys('-bar-'); return sendKeys(powerInputEle, '-bar-'); }).then(function () { expect(titleEle.getText()).toContain('Windstorm-foo- can sing-bar-'); // 7 == 2 previously + length of '-bar-' - expect(changeLogEles.count()).toEqual(logCount + 15, 'should add 15 more messages'); + expect(changeLogEles.count()).toEqual(logCount + 11, 'should add 11 more messages'); }); }); @@ -106,7 +106,7 @@ describe('Lifecycle hooks', function () { expect(commentEle.getText()).toContain('long name'); return logEles.count(); }).then(function(count) { - expect(logCount + 10).toEqual(count, '10 additional log messages should have been added'); + expect(logCount + 6).toEqual(count, '6 additional log messages should have been added'); logCount = count; return buttonEle.click(); }).then(function() { @@ -135,7 +135,7 @@ describe('Lifecycle hooks', function () { expect(commentEle.getText()).toContain('long name'); return logEles.count(); }).then(function(count) { - expect(logCount + 10).toEqual(count, '10 additional log messages should have been added'); + expect(logCount + 5).toEqual(count, '5 additional log messages should have been added'); logCount = count; return buttonEle.click(); }).then(function() { diff --git a/public/docs/_examples/package.json b/public/docs/_examples/package.json index 7c67a39ac2..bbf294cf28 100644 --- a/public/docs/_examples/package.json +++ b/public/docs/_examples/package.json @@ -25,22 +25,22 @@ "author": "", "license": "ISC", "dependencies": { - "@angular/common": "2.0.0-rc.1", - "@angular/compiler": "2.0.0-rc.1", - "@angular/core": "2.0.0-rc.1", - "@angular/http": "2.0.0-rc.1", - "@angular/platform-browser": "2.0.0-rc.1", - "@angular/platform-browser-dynamic": "2.0.0-rc.1", - "@angular/router": "2.0.0-rc.1", - "@angular/router-deprecated": "2.0.0-rc.1", - "@angular/upgrade": "2.0.0-rc.1", - "systemjs": "0.19.27", + "@angular/common": "2.0.0-rc.2", + "@angular/compiler": "2.0.0-rc.2", + "@angular/core": "2.0.0-rc.2", + "@angular/http": "2.0.0-rc.2", + "@angular/platform-browser": "2.0.0-rc.2", + "@angular/platform-browser-dynamic": "2.0.0-rc.2", + "@angular/router": "2.0.0-rc.2", + "@angular/router-deprecated": "2.0.0-rc.2", + "@angular/upgrade": "2.0.0-rc.2", + "angular2-in-memory-web-api": "0.0.11", + "bootstrap": "^3.3.6", "core-js": "^2.4.0", "reflect-metadata": "^0.1.3", "rxjs": "5.0.0-beta.6", - "zone.js": "^0.6.12", - "angular2-in-memory-web-api": "0.0.11", - "bootstrap": "^3.3.6" + "systemjs": "0.19.27", + "zone.js": "^0.6.12" }, "devDependencies": { "angular-cli": "^1.0.0-beta.5", diff --git a/public/docs/_examples/quickstart/js/index.html b/public/docs/_examples/quickstart/js/index.html index bec42f9dea..a1e88e0461 100644 --- a/public/docs/_examples/quickstart/js/index.html +++ b/public/docs/_examples/quickstart/js/index.html @@ -17,11 +17,11 @@ - - - - - + + + + + diff --git a/public/docs/_examples/quickstart/js/package.1.json b/public/docs/_examples/quickstart/js/package.1.json index b9365ca90d..48a8e408ff 100644 --- a/public/docs/_examples/quickstart/js/package.1.json +++ b/public/docs/_examples/quickstart/js/package.1.json @@ -7,15 +7,15 @@ }, "license": "ISC", "dependencies": { - "@angular/common": "2.0.0-rc.1", - "@angular/compiler": "2.0.0-rc.1", - "@angular/core": "2.0.0-rc.1", - "@angular/http": "2.0.0-rc.1", - "@angular/platform-browser": "2.0.0-rc.1", - "@angular/platform-browser-dynamic": "2.0.0-rc.1", - "@angular/router": "2.0.0-rc.1", - "@angular/router-deprecated": "2.0.0-rc.1", - "@angular/upgrade": "2.0.0-rc.1", + "@angular/common": "2.0.0-rc.2", + "@angular/compiler": "2.0.0-rc.2", + "@angular/core": "2.0.0-rc.2", + "@angular/http": "2.0.0-rc.2", + "@angular/platform-browser": "2.0.0-rc.2", + "@angular/platform-browser-dynamic": "2.0.0-rc.2", + "@angular/router": "2.0.0-rc.2", + "@angular/router-deprecated": "2.0.0-rc.2", + "@angular/upgrade": "2.0.0-rc.2", "core-js": "^2.4.0", "reflect-metadata": "0.1.3", diff --git a/public/docs/_examples/quickstart/ts/package.1.json b/public/docs/_examples/quickstart/ts/package.1.json index 8798091f8b..f59ab6da09 100644 --- a/public/docs/_examples/quickstart/ts/package.1.json +++ b/public/docs/_examples/quickstart/ts/package.1.json @@ -11,15 +11,15 @@ }, "license": "ISC", "dependencies": { - "@angular/common": "2.0.0-rc.1", - "@angular/compiler": "2.0.0-rc.1", - "@angular/core": "2.0.0-rc.1", - "@angular/http": "2.0.0-rc.1", - "@angular/platform-browser": "2.0.0-rc.1", - "@angular/platform-browser-dynamic": "2.0.0-rc.1", - "@angular/router": "2.0.0-rc.1", - "@angular/router-deprecated": "2.0.0-rc.1", - "@angular/upgrade": "2.0.0-rc.1", + "@angular/common": "2.0.0-rc.2", + "@angular/compiler": "2.0.0-rc.2", + "@angular/core": "2.0.0-rc.2", + "@angular/http": "2.0.0-rc.2", + "@angular/platform-browser": "2.0.0-rc.2", + "@angular/platform-browser-dynamic": "2.0.0-rc.2", + "@angular/router": "2.0.0-rc.2", + "@angular/router-deprecated": "2.0.0-rc.2", + "@angular/upgrade": "2.0.0-rc.2", "systemjs": "0.19.27", "core-js": "^2.4.0", diff --git a/public/docs/_examples/styleguide/js/index.html b/public/docs/_examples/styleguide/js/index.html index 6840d677d0..b7da03d83a 100644 --- a/public/docs/_examples/styleguide/js/index.html +++ b/public/docs/_examples/styleguide/js/index.html @@ -11,11 +11,11 @@ - - - - - + + + + + diff --git a/public/docs/_examples/systemjs.config.js b/public/docs/_examples/systemjs.config.js index 27dcf330a5..debd09b30e 100644 --- a/public/docs/_examples/systemjs.config.js +++ b/public/docs/_examples/systemjs.config.js @@ -39,7 +39,7 @@ // Bundled (~40 requests): function packUmd(pkgName) { - packages['@angular/'+pkgName] = { main: pkgName + '.umd.js', defaultExtension: 'js' }; + packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' }; } // Most environments should use UMD; some (Karma) need the individual index files diff --git a/public/docs/_examples/systemjs.config.plunker.js b/public/docs/_examples/systemjs.config.plunker.js index 6093653def..55d2a3bddc 100644 --- a/public/docs/_examples/systemjs.config.plunker.js +++ b/public/docs/_examples/systemjs.config.plunker.js @@ -5,7 +5,7 @@ */ (function(global) { - var ngVer = '@2.0.0-rc.1'; // lock in the angular package version; do not let it float to current! + var ngVer = '@2.0.0-rc.2'; // lock in the angular package version; do not let it float to current! //map tells the System loader where to look for things var map = { @@ -47,7 +47,7 @@ ngPackageNames.forEach(function(pkgName) { // Bundled (~40 requests): - packages['@angular/'+pkgName] = { main: pkgName + '.umd.js', defaultExtension: 'js' }; + packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' }; // Individual files (~300 requests): //packages['@angular/'+pkgName] = { main: 'index.js', defaultExtension: 'js' }; diff --git a/public/docs/_examples/template-syntax/ts/app/app.component.html b/public/docs/_examples/template-syntax/ts/app/app.component.html index 57f73c4cb2..dcfd423e50 100644 --- a/public/docs/_examples/template-syntax/ts/app/app.component.html +++ b/public/docs/_examples/template-syntax/ts/app/app.component.html @@ -585,7 +585,7 @@ bindon-ngModel

with trackBy and space separator

-
+
({{hero.id}}) {{hero.fullName}}
diff --git a/public/docs/_examples/upgrade-phonecat-2-hybrid/ts/systemjs.config.1.js b/public/docs/_examples/upgrade-phonecat-2-hybrid/ts/systemjs.config.1.js index 3a455980bb..a4134235b8 100644 --- a/public/docs/_examples/upgrade-phonecat-2-hybrid/ts/systemjs.config.1.js +++ b/public/docs/_examples/upgrade-phonecat-2-hybrid/ts/systemjs.config.1.js @@ -40,8 +40,8 @@ // Bundled (~40 requests): function packUmd(pkgName) { - packages['@angular/'+pkgName] = { main: pkgName + '.umd.js', defaultExtension: 'js' }; - }; + packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' }; + } var setPackageConfig = System.packageWithIndex ? packIndex : packUmd; diff --git a/public/docs/_examples/upgrade-phonecat-3-final/ts/systemjs.config.1.js b/public/docs/_examples/upgrade-phonecat-3-final/ts/systemjs.config.1.js index 3a455980bb..a4134235b8 100644 --- a/public/docs/_examples/upgrade-phonecat-3-final/ts/systemjs.config.1.js +++ b/public/docs/_examples/upgrade-phonecat-3-final/ts/systemjs.config.1.js @@ -40,8 +40,8 @@ // Bundled (~40 requests): function packUmd(pkgName) { - packages['@angular/'+pkgName] = { main: pkgName + '.umd.js', defaultExtension: 'js' }; - }; + packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' }; + } var setPackageConfig = System.packageWithIndex ? packIndex : packUmd; diff --git a/public/docs/js/latest/_data.json b/public/docs/js/latest/_data.json index 44be71ef79..57dd05410d 100644 --- a/public/docs/js/latest/_data.json +++ b/public/docs/js/latest/_data.json @@ -3,7 +3,7 @@ "icon": "home", "title": "Angular Docs", "menuTitle": "Docs Home", - "banner": "Welcome to Angular in JavaScript! The current Angular 2 release is rc.1. Please consult the Change Log about recent enhancements, fixes, and breaking changes." + "banner": "Welcome to Angular in JavaScript! The current Angular 2 release is rc.2. Please consult the Change Log about recent enhancements, fixes, and breaking changes." }, "quickstart": { diff --git a/public/docs/ts/latest/_data.json b/public/docs/ts/latest/_data.json index 6df7846a08..34d212d78e 100644 --- a/public/docs/ts/latest/_data.json +++ b/public/docs/ts/latest/_data.json @@ -3,7 +3,7 @@ "icon": "home", "title": "Angular Docs", "menuTitle": "Docs Home", - "banner": "Welcome to Angular in TypeScript! The current Angular 2 release is rc.1. Please consult the Change Log about recent enhancements, fixes, and breaking changes." + "banner": "Welcome to Angular in TypeScript! The current Angular 2 release is rc.2. Please consult the Change Log about recent enhancements, fixes, and breaking changes." }, "cli-quickstart": {