Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 93070f1

Browse files
prognostikosbtford
authored andcommitted
docs(guide): minor grammar fixes
1 parent 3c8583e commit 93070f1

32 files changed

+201
-177
lines changed

docs/content/cookbook/buzz.ngdoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
@description
44

55
External resources are URLs that provide JSON data, which are then rendered with the help of
6-
templates. angular has a resource factory that can be used to give names to the URLs and then
6+
templates. Angular has a resource factory that can be used to give names to the URLs and then
77
attach behavior to them. For example you can use the
88
{@link http://code.google.com/apis/buzz/v1/getting_started.html#background-operations| Google Buzz
99
API}

docs/content/cookbook/deeplinking.ngdoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Deep linking allows you to encode the state of the application in the URL so that it can be
66
bookmarked and the application can be restored from the URL to the same state.
77

8-
While angular does not force you to deal with bookmarks in any particular way, it has services
8+
While Angular does not force you to deal with bookmarks in any particular way, it has services
99
which make the common case described here very easy to implement.
1010

1111
# Assumptions

docs/content/cookbook/form.ngdoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
@name Cookbook: Form
33
@description
44

5-
A web application's main purpose is to present and gather data. For this reason angular strives
5+
A web application's main purpose is to present and gather data. For this reason Angular strives
66
to make both of these operations trivial. This example shows off how you can build a simple form to
77
allow a user to enter data.
88

docs/content/cookbook/helloworld.ngdoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828

2929
Take a look through the source and note:
3030

31-
* The script tag that {@link guide/bootstrap bootstraps} the angular environment.
31+
* The script tag that {@link guide/bootstrap bootstraps} the Angular environment.
3232
* The text {@link api/ng.directive:input input form control} which is
3333
bound to the greeting name text.
34-
* No need for listener registration and event firing on change events.
34+
* There is no need for listener registration and event firing on change events.
3535
* The implicit presence of the `name` variable which is in the root {@link api/ng.$rootScope.Scope scope}.
3636
* The double curly brace `{{markup}}`, which binds the name variable to the greeting text.
3737
* The concept of {@link guide/dev_guide.templates.databinding data binding}, which reflects any

docs/content/cookbook/index.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
@name Cookbook
33
@description
44

5-
Welcome to the angular cookbook. Here we will show you typical uses of angular by example.
5+
Welcome to the Angular cookbook. Here we will show you typical uses of Angular by example.
66

77

88
# Hello World
@@ -45,7 +45,7 @@ allowing you to send links to specific screens in your app.
4545
# Services
4646

4747
{@link api/ng Services}: Services are long lived objects in your applications that are
48-
available across controllers. A collection of useful services are pre-bundled with angular but you
48+
available across controllers. A collection of useful services are pre-bundled with Angular but you
4949
will likely add your own. Services are initialized using dependency injection, which resolves the
5050
order of initialization. This safeguards you from the perils of global state (a common way to
5151
implement long lived objects).
@@ -55,4 +55,4 @@ implement long lived objects).
5555

5656
{@link buzz Resources}: Web applications must be able to communicate with the external
5757
services to get and update data. Resources are the abstractions of external URLs which are
58-
specially tailored to angular data binding.
58+
specially tailored to Angular data binding.

docs/content/cookbook/mvc.ngdoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
@name Cookbook: MVC
33
@description
44

5-
MVC allows for a clean an testable separation between the behavior (controller) and the view
5+
MVC allows for a clean and testable separation between the behavior (controller) and the view
66
(HTML template). A Controller is just a JavaScript class which is grafted onto the scope of the
77
view. This makes it very easy for the controller and the view to share the model.
88

@@ -115,7 +115,7 @@ view.
115115
# Things to notice
116116

117117
* The controller is defined in JavaScript and has no reference to the rendering logic.
118-
* The controller is instantiated by <angular/> and injected into the view.
118+
* The controller is instantiated by Angular and injected into the view.
119119
* The controller can be instantiated in isolation (without a view) and the code will still execute.
120120
This makes it very testable.
121121
* The HTML view is a projection of the model. In the above example, the model is stored in the

docs/content/guide/compiler.ngdoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ browser new HTML syntax. The compiler allows you to attach behavior to any HTML
99
and even create new HTML element or attributes with custom behavior. Angular calls these behavior
1010
extensions {@link api/ng.$compileProvider#directive directives}.
1111

12-
HTML has a lot of constructs for formatting the HTML for static documents in declarative fashion.
12+
HTML has a lot of constructs for formatting the HTML for static documents in a declarative fashion.
1313
For example if something needs to be centered, there is no need to provide instructions to the
1414
browser how the window size needs to be divided in half so that center is found, and that this
1515
center needs to be aligned with the text's center. Simply add `align="center"` attribute to any
@@ -37,7 +37,7 @@ process happens into two phases.
3737

3838
2. **Link:** combine the directives with a scope and produce a live view. Any changes in the
3939
scope model are reflected in the view, and any user interactions with the view are reflected
40-
in the scope model. Making the scope model a single source of truth.
40+
in the scope model. This makes the scope model the single source of truth.
4141

4242
Some directives such {@link api/ng.directive:ngRepeat
4343
`ng-repeat`} clone DOM elements once for each item in collection. Having a compile and link phase
@@ -47,9 +47,9 @@ once for each clone instance.
4747

4848
# Directive
4949

50-
Directive is a behavior which should be triggered when specific HTML constructs are encountered in
51-
compilation process. The directives can be placed in element names, attributes, class names, as
52-
well as comments. Here are some equivalent examples of invoking {@link
50+
A directive is a behavior which should be triggered when specific HTML constructs are encountered in
51+
the compilation process. The directives can be placed in element names, attributes, class names, as
52+
well as comments. Here are some equivalent examples of invoking the {@link
5353
api/ng.directive:ngBind `ng-bind`} directive.
5454

5555
<pre>
@@ -59,7 +59,7 @@ api/ng.directive:ngBind `ng-bind`} directive.
5959
<!-- directive: ng-bind exp -->
6060
</pre>
6161

62-
Directive is just a function which executes when the compiler encounters it in the DOM. See {@link
62+
A directive is just a function which executes when the compiler encounters it in the DOM. See {@link
6363
api/ng.$compileProvider#directive directive API} for in-depth documentation on how
6464
to write directives.
6565

@@ -107,9 +107,9 @@ Here is a directive which makes any element draggable. Notice the `draggable` at
107107
</example>
108108

109109

110-
The presence of `draggable` attribute on any element gives the element new behavior. The beauty of
110+
The presence of the `draggable` attribute on any element gives the element new behavior. The beauty of
111111
this approach is that we have taught the browser a new trick. We have extended the vocabulary of
112-
what the browser understands in a way, which is natural to anyone who is familiar with HTML
112+
what the browser understands in a way which is natural to anyone who is familiar with HTML
113113
principles.
114114

115115

@@ -122,7 +122,7 @@ an element.
122122
<img src="img/One_Way_Data_Binding.png">
123123

124124
This means that any changes to the data need to be re-merged with the template and then
125-
`innerHTML`ed into the DOM. Some of the issues are: reading user input and merging it with data,
125+
`innerHTML`ed into the DOM. Some of the issues with this approach are: reading user input and merging it with data,
126126
clobbering user input by overwriting it, managing the whole update process, and lack of behavior
127127
expressiveness.
128128

docs/content/guide/concepts.ngdoc

+28-28
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ This is how we get the ball rolling (refer to the diagram and example below):
2626

2727
<img class="pull-right" style="padding-left: 3em;" src="img/guide/concepts-startup.png">
2828

29-
1. Browser loads the HTML and parses it into a DOM
30-
2. Browser loads `angular.js` script
29+
1. The browser loads the HTML and parses it into a DOM
30+
2. The browser loads `angular.js` script
3131
3. Angular waits for `DOMContentLoaded` event
3232
4. Angular looks for {@link api/ng.directive:ngApp ng-app}
33-
{@link guide/directive directive}, which designates application boundary
34-
5. {@link guide/module Module} specified in {@link
33+
{@link guide/directive directive}, which designates the application boundary
34+
5. The {@link guide/module Module} specified in {@link
3535
api/ng.directive:ngApp ng-app} (if any) is used to configure
3636
the {@link api/AUTO.$injector $injector}
37-
6. {@link api/AUTO.$injector $injector} is used to create the {@link
37+
6. The {@link api/AUTO.$injector $injector} is used to create the {@link
3838
api/ng.$compile $compile} service as well as {@link
3939
api/ng.$rootScope $rootScope}
40-
7. {@link api/ng.$compile $compile} service is used to compile the DOM and link
40+
7. The {@link api/ng.$compile $compile} service is used to compile the DOM and link
4141
it with {@link api/ng.$rootScope $rootScope}
42-
8. {@link api/ng.directive:ngInit ng-init} {@link
42+
8. The {@link api/ng.directive:ngInit ng-init} {@link
4343
guide/directive directive} assigns `World` to the `name` property on the {@link guide/scope
4444
scope}
4545
9. The `{{name}}` {@link api/ng.$interpolate interpolates} the expression to
@@ -59,21 +59,21 @@ This is how we get the ball rolling (refer to the diagram and example below):
5959

6060
<img class="pull-right" style="padding-left: 3em; padding-bottom: 1em;" src="img/guide/concepts-runtime.png">
6161

62-
The diagram and the example below describe how Angular interacts with browser's event loop.
62+
The diagram and the example below describe how Angular interacts with the browser's event loop.
6363

64-
1. Browsers event-loop waits for an event to arrive. Event is a user interactions, timer event,
64+
1. The browser's event-loop waits for an event to arrive. An event is a user interactions, timer event,
6565
or network event (response from a server).
66-
2. The events callback gets executed. This enters the JavaScript context. The callback can
66+
2. The event's callback gets executed. This enters the JavaScript context. The callback can
6767
modify the DOM structure.
68-
3. Once the callback finishes execution, the browser leaves the JavaScript context and
68+
3. Once the callback executes, the browser leaves the JavaScript context and
6969
re-renders the view based on DOM changes.
7070

71-
Angular modifies the normal JavaScript flow by providing it's own event processing loop. This
71+
Angular modifies the normal JavaScript flow by providing its own event processing loop. This
7272
splits the JavaScript into classical and Angular execution context. Only operations which are
73-
applied in Angular execution context will benefit from angular data-binding, exception handling,
74-
property watching, etc... Use $apply() to enter Angular execution context from JavaScript. Keep in
75-
mind that in most places (controllers, services) the $apply has already been called for you by the
76-
directive which is handling the event. The need to call $apply is reserved only when
73+
applied in Angular execution context will benefit from Angular data-binding, exception handling,
74+
property watching, etc... You can also use $apply() to enter Angular execution context from JavaScript. Keep in
75+
mind that in most places (controllers, services) $apply has already been called for you by the
76+
directive which is handling the event. An explicit call to $apply is needed only when
7777
implementing custom event callbacks, or when working with a third-party library callbacks.
7878

7979
1. Enter Angular execution context by calling {@link guide/scope scope}`.`{@link
@@ -89,14 +89,14 @@ implementing custom event callbacks, or when working with a third-party library
8989
$evalAsync} queue is empty and the {@link api/ng.$rootScope.Scope#$watch
9090
$watch} list does not detect any changes.
9191
4. The {@link api/ng.$rootScope.Scope#$evalAsync $evalAsync} queue is used to
92-
schedule work which needs to occur outside of current stack frame, but before the browser
92+
schedule work which needs to occur outside of current stack frame, but before the browser's
9393
view render. This is usually done with `setTimeout(0)`, but the `setTimeout(0)` approach
9494
suffers from slowness and may cause view flickering since the browser renders the view after
9595
each event.
9696
5. The {@link api/ng.$rootScope.Scope#$watch $watch} list is a set of expressions
9797
which may have changed since last iteration. If a change is detected then the `$watch`
9898
function is called which typically updates the DOM with the new value.
99-
6. Once Angular {@link api/ng.$rootScope.Scope#$digest $digest} loop finishes
99+
6. Once the Angular {@link api/ng.$rootScope.Scope#$digest $digest} loop finishes
100100
the execution leaves the Angular and JavaScript context. This is followed by the browser
101101
re-rendering the DOM to reflect any changes.
102102

@@ -188,7 +188,7 @@ a diagram depicting the scope boundaries.
188188

189189
<img class="pull-right" style="padding-left: 3em; padding-bottom: 1em;" src="img/guide/concepts-controller.png">
190190

191-
Controller is the code behind the view. Its job is to construct the model and publish it to the
191+
A controller is the code behind the view. Its job is to construct the model and publish it to the
192192
view along with callback methods. The view is a projection of the scope onto the template (the
193193
HTML). The scope is the glue which marshals the model to the view and forwards the events to the
194194
controller.
@@ -233,7 +233,7 @@ The separation of the controller and the view is important because:
233233
<img class="pull-right" style="padding-left: 3em; padding-bottom: 1em;" src="img/guide/concepts-model.png">
234234

235235
The model is the data which is used merged with the template to produce the view. To be able to
236-
render the model into the view, the model has to be referenceable from the scope. Unlike many
236+
render the model into the view, the model has to be able to be referenced from the scope. Unlike many
237237
other frameworks Angular makes no restrictions or requirements an the model. There are no classes
238238
to inherit from or special accessor methods for accessing or changing the model. The model can be
239239
primitive, object hash, or a full object Type. In short the model is a plain JavaScript object.
@@ -250,7 +250,7 @@ primitive, object hash, or a full object Type. In short the model is a plain Jav
250250

251251
The view is what the users sees. The view begins its life as a template, it is merged with the
252252
model and finally rendered into the browser DOM. Angular takes a very different approach to
253-
rendering the view, to most other templating systems.
253+
rendering the view, compared to most other templating systems.
254254

255255
* **Others** - Most templating systems begin as an HTML string with special templating markup.
256256
Often the template markup breaks the HTML syntax which means that the template can not be
@@ -261,9 +261,9 @@ rendering the view, to most other templating systems.
261261
is the granularity of the DOM updates. The key here is that the templating system manipulates
262262
strings.
263263
* **Angular** - Angular is different, since its templating system works on DOM objects not on
264-
strings. The template is still written in HTML string, but it is HTML (not HTML with
265-
template sprinkled in.) The browser parses the HTML into DOM, and the DOM becomes the input to
266-
the template engine know as the {@link api/ng.$compile compiler}. The compiler
264+
strings. The template is still written in an HTML string, but it is HTML (not HTML with
265+
template sprinkled in.) The browser parses the HTML into the DOM, and the DOM becomes the input to
266+
the template engine known as the {@link api/ng.$compile compiler}. The compiler
267267
looks for {@link guide/directive directives} which in turn set up {@link
268268
api/ng.$rootScope.Scope#$watch watches} on the model. The result is a
269269
continuously updating view which does not need template model re-merging. Your model becomes
@@ -291,7 +291,7 @@ rendering the view, to most other templating systems.
291291
<a name="directives"></a>
292292
# Directives
293293

294-
A directive is a behavior or DOM transformation which is triggered by a presence of an attribute,
294+
A directive is a behavior or DOM transformation which is triggered by the presence of a custom attribute,
295295
element name, or a class name. A directive allows you to extend the HTML vocabulary in a
296296
declarative fashion. Following is an example which enables data-binding for the `contenteditable`
297297
in HTML.
@@ -337,7 +337,7 @@ in HTML.
337337
<a name="filters"></a>
338338
# Filters
339339

340-
{@link api/ng.$filter Filters} perform data transformation roles. Typically
340+
{@link api/ng.$filter Filters} perform data transformation. Typically
341341
they are used in conjunction with the locale to format the data in locale specific output.
342342
They follow the spirit of UNIX filters and use similar syntax `|` (pipe).
343343

@@ -358,7 +358,7 @@ They follow the spirit of UNIX filters and use similar syntax `|` (pipe).
358358

359359
<img class="pull-right" style="padding-left: 3em; padding-bottom: 1em;" src="img/guide/concepts-module-injector.png">
360360

361-
An {@link api/AUTO.$injector injector} is a service locator. There is a single
361+
The {@link api/AUTO.$injector injector} is a service locator. There is a single
362362
{@link api/AUTO.$injector injector} per Angular {@link
363363
api/ng.directive:ngApp application}. The {@link
364364
api/AUTO.$injector injector} provides a way to look up an object instance by its
@@ -438,7 +438,7 @@ dependencies, look for dependencies, or even get a reference to the injector.
438438
</file>
439439
<file name="script.js">
440440
angular.module('timeExampleModule', []).
441-
// Declare new object call time,
441+
// Declare new object called time,
442442
// which will be available for injection
443443
factory('time', function($timeout) {
444444
var time = {};

docs/content/guide/dev_guide.e2e-testing.ngdoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ that will help you verify the health of your Angular application.
1111

1212
# Overview
1313
You will write scenario tests in JavaScript, which describe how your application should behave,
14-
given a certain interaction in a specific state. A scenario is comprised of one or more it blocks
14+
given a certain interaction in a specific state. A scenario is comprised of one or more `it` blocks
1515
(you can think of these as the requirements of your application), which in turn are made of
1616
**commands** and **expectations**. Commands tell the Runner to do something with the application
1717
(such as navigate to a page or click on a button), and expectations tell the Runner to assert
@@ -175,4 +175,4 @@ Executes the `method` passing in `key` and `value` on the element matching the g
175175
JavaScript is a dynamically typed language which comes with great power of expression, but it also
176176
come with almost no-help from the compiler. For this reason we feel very strongly that any code
177177
written in JavaScript needs to come with a strong set of tests. We have built many features into
178-
angular which makes testing your angular applications easy. So there is no excuse for not do it.
178+
angular which makes testing your angular applications easy. So there is no excuse for not testing.

docs/content/guide/dev_guide.mvc.ngdoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
@description
44

55
While Model-View-Controller (MVC) has acquired different shades of meaning over the years since it
6-
first appeared, angular incorporates the basic principles behind the original {@link
6+
first appeared, Angular incorporates the basic principles behind the original {@link
77
http://en.wikipedia.org/wiki/Model–view–controller MVC} software design pattern into its way of
88
building client-side web applications.
99

10-
The MVC pattern greatly summarized:
10+
The MVC pattern summarized:
1111

1212
* Separate applications into distinct presentation, data, and logic components
1313
* Encourage loose coupling between these components

0 commit comments

Comments
 (0)