New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy edit: /angular/guide/architecture #1202

Merged
merged 2 commits into from Dec 6, 2017

Conversation

Projects
None yet
4 participants
@sarahmaddox
Contributor

sarahmaddox commented Nov 24, 2017

A light tech-writer review as part of a Write the Docs doc sprint.

Copy edit: /angular/guide/architecture
A light tech-writer review as part of a Write the Docs doc sprint.

@googlebot googlebot added the cla: yes label Nov 24, 2017

@kwalrath kwalrath self-requested a review Dec 5, 2017

@kwalrath

Nice edits! I had one small issue, and I need to check the rendered page to make sure the formatting in one part is OK. (That can happen after committing, though.)

```
<input [(ngModel)]="hero.name">
```
<?code-excerpt "lib/src/hero_detail_component.html (ngModel)" title?>

This comment has been minimized.

@kwalrath

kwalrath Dec 6, 2017

Member

NOTE TO SELF: Make sure this renders OK.

@kwalrath

kwalrath Dec 6, 2017

Member

NOTE TO SELF: Make sure this renders OK.

This comment has been minimized.

@kwalrath

kwalrath Dec 6, 2017

Member

Oops, it doesn't. I'll fix it now.

@kwalrath

kwalrath Dec 6, 2017

Member

Oops, it doesn't. I'll fix it now.

This comment has been minimized.

@chalin

chalin Dec 6, 2017

Collaborator

It is difficult to get the markdown triple back-tick notation to work when indented, and part of a <?code-excerpt?> instruction. This is why the code excerpt was originally left outside of the list item.

At the cost of losing the title, you can use our custom Liquid prettify tag like as a quick fix:

* The fourth form of data binding is **two-way data binding** ...
  
  <?code-excerpt "lib/src/hero_detail_component.html (ngModel)" indent-by="0"?>
  {% prettify html %}
  <input [(ngModel)]="hero.name">
  {% endprettify %}

(Take note of the change in the <?code-excerpt?> instruction.)

@chalin

chalin Dec 6, 2017

Collaborator

It is difficult to get the markdown triple back-tick notation to work when indented, and part of a <?code-excerpt?> instruction. This is why the code excerpt was originally left outside of the list item.

At the cost of losing the title, you can use our custom Liquid prettify tag like as a quick fix:

* The fourth form of data binding is **two-way data binding** ...
  
  <?code-excerpt "lib/src/hero_detail_component.html (ngModel)" indent-by="0"?>
  {% prettify html %}
  <input [(ngModel)]="hero.name">
  {% endprettify %}

(Take note of the change in the <?code-excerpt?> instruction.)

You can also write your own directives. Components such as
`HeroListComponent` are one kind of custom directive. Learn about writing a
[custom structural directive](/angular/guide/structural-directives#unless).

This comment has been minimized.

@kwalrath

kwalrath Dec 6, 2017

Member

Nice link!

@kwalrath

kwalrath Dec 6, 2017

Member

Nice link!

Show outdated Hide outdated src/angular/guide/architecture.md

@kwalrath kwalrath merged commit 441b102 into dart-lang:master Dec 6, 2017

1 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
cla/google All necessary CLAs are signed

kwalrath added a commit that referenced this pull request Dec 6, 2017

Fix formatting of architecture guide (#1213)
Also a bit of copy editing. Fixed list structure and made URLs
consistent.

Related to #1202.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment