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

Commit 801ac76

Browse files
chalinkwalrath
chalin
authored and
kwalrath
committed
docs(guide/displaying-data): proofread (#1819)
* docs(displaying-data/dart): proofread - Dart prose simplified by removing discussion of "additions to pubspec.yaml" which are no longer necessary given the current state of QuickStart. - E2e suites passed: public/docs/_examples/displaying-data/dart public/docs/_examples/displaying-data/ts Contributes to #1598 and #1508. * docs(displaying-data/ts): proofread - TS prose updated to include @kwalrath's revisions from a while ago, with some of my edits as well. - E2e suites passed: public/docs/_examples/displaying-data/dart public/docs/_examples/displaying-data/ts * docs(displaying-data/ts): post-review edits
1 parent ff718f4 commit 801ac76

17 files changed

+221
-457
lines changed

‎public/docs/_examples/displaying-data/dart/lib/app_component.dart

+19-21
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,28 @@ import 'package:angular2/core.dart';
33

44
import 'hero.dart';
55

6-
final List<Hero> _heroes = [
7-
new Hero(1, 'Windstorm'),
8-
new Hero(13, 'Bombasto'),
9-
new Hero(15, 'Magneta'),
10-
new Hero(20, 'Tornado')
11-
];
12-
136
@Component(
147
selector: 'my-app',
158
template: '''
16-
<h1>{{title}}</h1>
17-
<h2>My favorite hero is: {{myHero.name}}</h2>
18-
<p>Heroes:</p>
19-
<ul>
20-
<li *ngFor="let hero of heroes">
21-
{{ hero.name }}
22-
</li>
23-
</ul>
24-
// #docregion message
25-
<p *ngIf="heroes.length > 3">There are many heroes!</p>
26-
// #enddocregion message
27-
''')
9+
<h1>{{title}}</h1>
10+
<h2>My favorite hero is: {{myHero.name}}</h2>
11+
<p>Heroes:</p>
12+
<ul>
13+
<li *ngFor="let hero of heroes">
14+
{{ hero.name }}
15+
</li>
16+
</ul>
17+
// #docregion message
18+
<p *ngIf="heroes.length > 3">There are many heroes!</p>
19+
// #enddocregion message
20+
''')
2821
class AppComponent {
2922
String title = 'Tour of Heroes';
30-
List<Hero> heroes = _heroes;
31-
Hero myHero = _heroes[0];
23+
List<Hero> heroes = [
24+
new Hero(1, 'Windstorm'),
25+
new Hero(13, 'Bombasto'),
26+
new Hero(15, 'Magneta'),
27+
new Hero(20, 'Tornado')
28+
];
29+
Hero get myHero => heroes.first;
3230
}

‎public/docs/_examples/displaying-data/dart/lib/app_component_1.dart

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ import 'package:angular2/core.dart';
33

44
@Component(
55
selector: 'my-app',
6-
// #docregion template
6+
// #docregion template
77
template: '''
8-
<h1>{{title}}</h1>
9-
<h2>My favorite hero is: {{myHero}}</h2>'''
10-
// #enddocregion template
8+
<h1>{{title}}</h1>
9+
<h2>My favorite hero is: {{myHero}}</h2>
10+
'''
11+
// #enddocregion template
1112
)
1213
class AppComponent {
1314
String title = 'Tour of Heroes';

‎public/docs/_examples/displaying-data/dart/lib/app_component_2.dart

+16-26
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,26 @@
11
// #docregion
22
import 'package:angular2/core.dart';
33

4-
// #docregion mock-heroes
5-
const List<String> _heroes = const [
6-
'Windstorm',
7-
'Bombasto',
8-
'Magneta',
9-
'Tornado'
10-
];
11-
// #enddocregion mock-heroes
12-
134
@Component(
145
selector: 'my-app',
15-
// #docregion template
6+
// #docregion template
167
template: '''
17-
<h1>{{title}}</h1>
18-
<h2>My favorite hero is: {{myHero}}</h2>
19-
<p>Heroes:</p>
20-
<ul>
21-
// #docregion li-repeater
22-
<li *ngFor="let hero of heroes">
23-
{{ hero }}
24-
</li>
25-
// #enddocregion li-repeater
26-
</ul>'''
27-
// #enddocregion template
8+
<h1>{{title}}</h1>
9+
<h2>My favorite hero is: {{myHero}}</h2>
10+
<p>Heroes:</p>
11+
<ul>
12+
// #docregion li
13+
<li *ngFor="let hero of heroes">
14+
{{ hero }}
15+
</li>
16+
// #enddocregion li
17+
</ul>
18+
'''
19+
// #enddocregion template
2820
)
29-
// #docregion mock-heroes
21+
// #docregion class
3022
class AppComponent {
3123
String title = 'Tour of Heroes';
32-
List<String> heroes = _heroes;
33-
String myHero = _heroes[0];
24+
List<String> heroes = ['Windstorm', 'Bombasto', 'Magneta', 'Tornado'];
25+
String get myHero => heroes.first;
3426
}
35-
// #enddocregion mock-heroes
36-
// #enddocregion

‎public/docs/_examples/displaying-data/dart/lib/app_component_3.dart

+23-24
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
// #docregion
22
import 'package:angular2/core.dart';
3-
// #docregion heroes
3+
// #docregion import
44
import 'hero.dart';
5-
6-
final List<Hero> _heroes = [
7-
new Hero(1, 'Windstorm'),
8-
new Hero(13, 'Bombasto'),
9-
new Hero(15, 'Magneta'),
10-
new Hero(20, 'Tornado')
11-
];
12-
// #enddocregion heroes
5+
// #enddocregion import
136

147
@Component(
158
selector: 'my-app',
16-
// #docregion template
9+
// #docregion template
1710
template: '''
18-
<h1>{{title}}</h1>
19-
<h2>My favorite hero is: {{myHero.name}}</h2>
20-
<p>Heroes:</p>
21-
<ul>
22-
<li *ngFor="let hero of heroes">
23-
{{ hero.name }}
24-
</li>
25-
</ul>'''
26-
// #enddocregion template
11+
<h1>{{title}}</h1>
12+
<h2>My favorite hero is: {{myHero.name}}</h2>
13+
<p>Heroes:</p>
14+
<ul>
15+
<li *ngFor="let hero of heroes">
16+
{{ hero.name }}
17+
</li>
18+
</ul>
19+
'''
20+
// #enddocregion template
2721
)
28-
// #docregion heroes
22+
// #docregion class
2923
class AppComponent {
3024
String title = 'Tour of Heroes';
31-
List<Hero> heroes = _heroes;
32-
Hero myHero = _heroes[0];
25+
// #docregion heroes
26+
List<Hero> heroes = [
27+
new Hero(1, 'Windstorm'),
28+
new Hero(13, 'Bombasto'),
29+
new Hero(15, 'Magneta'),
30+
new Hero(20, 'Tornado')
31+
];
32+
Hero get myHero => heroes.first;
33+
// #enddocregion heroes
3334
}
34-
// #enddocregion heroes
35-
// #enddocregion

‎public/docs/_examples/displaying-data/dart/lib/hero.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// #docregion
22
class Hero {
3-
int id;
3+
final int id;
44
String name;
55

66
Hero(this.id, this.name);
7+
78
String toString() => '$id: $name';
89
}
9-
// #enddocregion

‎public/docs/_examples/displaying-data/dart/pubspec.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# #docregion
22
name: displaying_data
3-
description: Displaying Data Example
3+
description: Displaying Data
44
version: 0.0.1
55
environment:
66
sdk: '>=1.13.0 <2.0.0'

‎public/docs/_examples/displaying-data/dart/web/index.html

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
<html>
44
<head>
55
<title>Displaying Data</title>
6-
<link rel="stylesheet" href="styles.css">
6+
<link rel="stylesheet" href="styles.css">
7+
78
<script defer src="main.dart" type="application/dart"></script>
89
<script defer src="packages/browser/dart.js"></script>
910
</head>
11+
<!-- #docregion body -->
1012
<body>
11-
<!-- #docregion my-app -->
1213
<my-app>Loading...</my-app>
13-
<!-- #enddocregion my-app -->
1414
</body>
15+
<!-- #enddocregion body -->
1516
</html>

‎public/docs/_examples/displaying-data/dart/web/main.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import 'package:angular2/platform/browser.dart';
99
// #docregion final
1010
import 'package:displaying_data/app_component.dart';
1111

12-
main() {
12+
void main() {
1313
// #enddocregion final
1414
// pick one
1515
// bootstrap(v1.AppComponent);

‎public/docs/_examples/displaying-data/ts/app/app-ctor.component.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Component } from '@angular/core';
77
<h2>My favorite hero is: {{myHero}}</h2>
88
`
99
})
10-
// #docregion app-ctor
10+
// #docregion class
1111
export class AppCtorComponent {
1212
title: string;
1313
myHero: string;
@@ -17,4 +17,3 @@ export class AppCtorComponent {
1717
this.myHero = 'Windstorm';
1818
}
1919
}
20-
// #enddocregion app-ctor

‎public/docs/_examples/displaying-data/ts/app/app.component.2.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,18 @@ import { Component } from '@angular/core';
99
<h2>My favorite hero is: {{myHero}}</h2>
1010
<p>Heroes:</p>
1111
<ul>
12-
// #docregion li-repeater
12+
// #docregion li
1313
<li *ngFor="let hero of heroes">
1414
{{ hero }}
1515
</li>
16-
// #enddocregion li-repeater
16+
// #enddocregion li
1717
</ul>
1818
`
1919
// #enddocregion template
2020
})
21-
// #docregion mock-heroes
21+
// #docregion class
2222
export class AppComponent {
2323
title = 'Tour of Heroes';
2424
heroes = ['Windstorm', 'Bombasto', 'Magneta', 'Tornado'];
2525
myHero = this.heroes[0];
2626
}
27-
// #enddocregion mock-heroes
28-
// #enddocregion

‎public/docs/_examples/displaying-data/ts/app/app.component.3.ts

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// #docregion
22
import { Component } from '@angular/core';
3-
// #docregion import-hero
3+
// #docregion import
44
import { Hero } from './hero';
5-
// #enddocregion import-hero
5+
// #enddocregion import
66

77
@Component({
88
selector: 'my-app',
@@ -32,5 +32,3 @@ export class AppComponent {
3232
myHero = this.heroes[0];
3333
// #enddocregion heroes
3434
}
35-
// #enddocregion class
36-
// #enddocregion

‎public/docs/_examples/displaying-data/ts/app/app.component.ts

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
// #docplaster
22
// #docregion final
3-
// #docregion imports
43
import { Component } from '@angular/core';
5-
// #enddocregion imports
64
import { Hero } from './hero';
75

86
@Component({
@@ -17,12 +15,10 @@ import { Hero } from './hero';
1715
</li>
1816
</ul>
1917
// #docregion message
20-
<p *ngIf="heroes.length
21-
> 3">There are many heroes!</p>
18+
<p *ngIf="heroes.length > 3">There are many heroes!</p>
2219
// #enddocregion message
2320
`
2421
})
25-
2622
export class AppComponent {
2723
title = 'Tour of Heroes';
2824
heroes = [

‎public/docs/_examples/displaying-data/ts/app/hero.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// #docregion
22
export class Hero {
33
constructor(
4-
// #docregion id-parameter
4+
// #docregion id
55
public id: number,
6-
// #enddocregion id-parameter
6+
// #enddocregion id
77
public name: string) { }
88
}
99
// #enddocregion

‎public/docs/_examples/displaying-data/ts/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
</script>
2020
</head>
2121

22-
<!-- #docregion my-app -->
22+
<!-- #docregion body -->
2323
<body>
2424
<my-app>loading...</my-app>
2525
</body>
26-
<!-- #enddocregion my-app -->
26+
<!-- #enddocregion body -->
2727

2828
</html>

‎public/docs/dart/latest/_quickstart_repo.jade

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.l-sub-section
2+
:marked
3+
Alternatively, begin with a
4+
[download of the QuickStart source](https://github.com/angular-examples/quickstart/archive/master.zip).

0 commit comments

Comments
 (0)