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

Commit 3fe0fb0

Browse files
chalinkwalrath
authored andcommitted
docs(toh-6/ts): minor edits and enhancements (#1686)
* docs(toh-6/ts): minor edits and enhancements Changes to prose: - Complete TODO item of displaying `heroes.component` errors. - Mainly copyedits. - Add of blocks statements so that prose can be used on Dart side. - Show excerpt and briefly explain of changes (previously missing): - `app/hero-detail.component.html` - `app/heroes.component.ts` error handling - Add missing file to changed/added files listing and makeTabs - `toh-6/ts/app/in-memory-data.service.ts, - `toh-6/ts/sample.css` Code changes: - Mainly copyedits - Renamed `heroes.component.ts` `delete` to `deleteHero` to match naming of other methods * remove unnecessary change relative to toh-5
1 parent a843310 commit 3fe0fb0

10 files changed

+299
-239
lines changed

Diff for: public/_includes/_util-fns.jade

+4-3
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,15 @@ mixin makeExcerpt(_filePath, _region, _title, stylePatterns)
9696
- var filePath = adjustments.filePath;
9797
- var title = adjustments.title;
9898
- var region = _region || parenText;
99-
- var excerpt = !region || parenText === '' ? 'excerpt' : region;
99+
- var excerpt = !region || parenText === '' ? 'excerpt' : parenText || region;
100100
- if (title) title = title + ' (' + excerpt + ')';
101101
+makeExample(filePath, region, title, stylePatterns)(format='.')
102102

103-
//- Extract the doc example name from `current`.
103+
//- Get the doc example name either from `_example` if set, or
104+
//- extract the example name from `current`.
104105
- var getExampleName = function() {
105106
- var dir = current.path[current.path.length - 1];
106-
- return dir == 'latest' ? current.source : dir;
107+
- return _example ? _example : dir == 'latest' ? current.source : dir;
107108
- };
108109

109110
mixin makeTabs(filePaths, regions, tabNames, stylePatterns)

Diff for: public/docs/_examples/toh-6/ts/app/app.component.css

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
/* #docplaster */
2-
/* #docregion css */
1+
/* #docregion */
32
h1 {
43
font-size: 1.2em;
54
color: #999;
@@ -28,4 +27,3 @@ nav a:hover {
2827
nav a.router-link-active {
2928
color: #039be5;
3029
}
31-
/* #enddocregion css */

Diff for: public/docs/_examples/toh-6/ts/app/hero-detail.component.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,7 @@ <h2>{{hero.name}} details!</h2>
99
<input [(ngModel)]="hero.name" placeholder="name" />
1010
</div>
1111
<button (click)="goBack()">Back</button>
12+
<!-- #docregion save -->
1213
<button (click)="save()">Save</button>
13-
</div>
14+
<!-- #enddocregion save -->
15+
</div>

Diff for: public/docs/_examples/toh-6/ts/app/hero-detail.component.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ export class HeroDetailComponent implements OnInit {
5050
.catch(error => this.error = error); // TODO: Display error message
5151
}
5252
// #enddocregion save
53-
// #docregion goback
53+
// #docregion goBack
5454
goBack(savedHero: Hero = null) {
5555
this.close.emit(savedHero);
5656
if (this.navigated) { window.history.back(); }
5757
}
58-
// #enddocregion goback
58+
// #enddocregion goBack
5959
}
6060

Diff for: public/docs/_examples/toh-6/ts/app/hero.service.ts

+11-11
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ import { Hero } from './hero';
1212
@Injectable()
1313
export class HeroService {
1414

15+
// #docregion getHeroes
1516
private heroesUrl = 'app/heroes'; // URL to web api
1617

1718
constructor(private http: Http) { }
1819

19-
// #docregion get-heroes
2020
getHeroes(): Promise<Hero[]> {
2121
return this.http.get(this.heroesUrl)
2222
// #docregion to-promise
@@ -29,7 +29,7 @@ export class HeroService {
2929
.catch(this.handleError);
3030
// #enddocregion catch
3131
}
32-
// #enddocregion get-heroes
32+
// #enddocregion getHeroes
3333

3434
getHero(id: number) {
3535
return this.getHeroes()
@@ -45,7 +45,7 @@ export class HeroService {
4545
}
4646
// #enddocregion save
4747

48-
// #docregion delete-hero
48+
// #docregion delete
4949
delete(hero: Hero) {
5050
let headers = new Headers();
5151
headers.append('Content-Type', 'application/json');
@@ -57,9 +57,9 @@ export class HeroService {
5757
.toPromise()
5858
.catch(this.handleError);
5959
}
60-
// #enddocregion delete-hero
60+
// #enddocregion delete
6161

62-
// #docregion post-hero
62+
// #docregion post
6363
// Add new Hero
6464
private post(hero: Hero): Promise<Hero> {
6565
let headers = new Headers({
@@ -71,9 +71,9 @@ export class HeroService {
7171
.then(res => res.json().data)
7272
.catch(this.handleError);
7373
}
74-
// #enddocregion post-hero
74+
// #enddocregion post
7575

76-
// #docregion put-hero
76+
// #docregion put
7777
// Update existing Hero
7878
private put(hero: Hero) {
7979
let headers = new Headers();
@@ -87,13 +87,13 @@ export class HeroService {
8787
.then(() => hero)
8888
.catch(this.handleError);
8989
}
90-
// #enddocregion put-hero
90+
// #enddocregion put
9191

92-
// #docregion error-handler
92+
// #docregion handleError
9393
private handleError(error: any) {
9494
console.error('An error occurred', error);
9595
return Promise.reject(error.message || error);
9696
}
97-
// #enddocregion error-handler
97+
// #enddocregion handleError
9898
}
99-
// #enddocregion
99+

Diff for: public/docs/_examples/toh-6/ts/app/heroes.component.html

+6-5
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,19 @@ <h2>My Heroes</h2>
55
<span class="hero-element">
66
<span class="badge">{{hero.id}}</span> {{hero.name}}
77
</span>
8-
<!-- #docregion delete-hero -->
9-
<button class="delete-button" (click)="delete(hero, $event)">Delete</button>
10-
<!-- #enddocregion delete-hero -->
8+
<!-- #docregion delete -->
9+
<button class="delete-button" (click)="deleteHero(hero, $event)">Delete</button>
10+
<!-- #enddocregion delete -->
1111
</li>
1212
</ul>
1313

14-
<!-- #docregion add-hero -->
14+
<!-- #docregion add-and-error -->
15+
<div class="error" *ngIf="error">{{error}}</div>
1516
<button (click)="addHero()">Add New Hero</button>
1617
<div *ngIf="addingHero">
1718
<my-hero-detail (close)="close($event)"></my-hero-detail>
1819
</div>
19-
<!-- #enddocregion add-hero -->
20+
<!-- #enddocregion add-and-error -->
2021

2122
<div *ngIf="selectedHero">
2223
<h2>

Diff for: public/docs/_examples/toh-6/ts/app/heroes.component.ts

+9-7
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ export class HeroesComponent implements OnInit {
1818
heroes: Hero[];
1919
selectedHero: Hero;
2020
addingHero = false;
21+
// #docregion error
2122
error: any;
23+
// #enddocregion error
2224

2325
constructor(
2426
private router: Router,
@@ -28,10 +30,10 @@ export class HeroesComponent implements OnInit {
2830
this.heroService
2931
.getHeroes()
3032
.then(heroes => this.heroes = heroes)
31-
.catch(error => this.error = error); // TODO: Display error message
33+
.catch(error => this.error = error);
3234
}
3335

34-
// #docregion add
36+
// #docregion addHero
3537
addHero() {
3638
this.addingHero = true;
3739
this.selectedHero = null;
@@ -41,20 +43,20 @@ export class HeroesComponent implements OnInit {
4143
this.addingHero = false;
4244
if (savedHero) { this.getHeroes(); }
4345
}
44-
// #enddocregion add
46+
// #enddocregion addHero
4547

46-
// #docregion delete
47-
delete(hero: Hero, event: any) {
48+
// #docregion deleteHero
49+
deleteHero(hero: Hero, event: any) {
4850
event.stopPropagation();
4951
this.heroService
5052
.delete(hero)
5153
.then(res => {
5254
this.heroes = this.heroes.filter(h => h !== hero);
5355
if (this.selectedHero === hero) { this.selectedHero = null; }
5456
})
55-
.catch(error => this.error = error); // TODO: Display error message
57+
.catch(error => this.error = error);
5658
}
57-
// #enddocregion delete
59+
// #enddocregion deleteHero
5860

5961
ngOnInit() {
6062
this.getHeroes();

Diff for: public/docs/_examples/toh-6/ts/app/in-memory-data.service.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// #docregion
1+
// #docregion , init
22
export class InMemoryDataService {
33
createDb() {
44
let heroes = [

Diff for: public/docs/_examples/toh-6/ts/sample.css

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1+
/* #docregion */
2+
.error {color:red;}
13
button.delete-button{
24
float:right;
35
background-color: gray !important;
46
color:white;
57
}
6-
7-
8-

0 commit comments

Comments
 (0)