Merge pull request #1169 from smirecki/master

[Documentation] Typo corrections

build-docs.sh

@@ -32,7 +32,7 @@ WEBSITE_DIRECTORY="website"
 BUILD_SHA=`git rev-parse HEAD`
 
 # A remote will be created for the git repository we are pushing to.
-# Don't worry, as this entire directory will get trashed inbetween builds.
+# Don't worry, as this entire directory will get trashed in between builds.
 REMOTE_NAME="documentation"
 WEBSITE_BRANCH="master"
 

docs/src/architecture/platform.md

@@ -616,7 +616,7 @@ follows:
   part of an action's extension definition.
 * `CreateActionProvider` provides the various Create actions which
   populate the Create menu. These are driven by the available types,
-  so do not map easily ot extension category `actions`; instead, these
+  so do not map easily to extension category `actions`; instead, these
   are generated after looking up which actions are available from the
   [`TypeService`](#type-service).
 * `ActionAggregator` merges together actions from multiple providers.

docs/src/design/proposals/APIRedesign.md

@@ -98,7 +98,7 @@ Worked on bug fixes in the platform and a plugin for search.
   It is hard to figure out what the difference between the various ways of
   dealing with telemetry are. e.g., what is the difference between just
   "Telemetry" and the "Telemetry Service"? There are many
-  "Telemetry Thing"s which seem related, but in an unclear way.
+  "Telemetry Things" which seem related, but in an unclear way.
 
 ### Developer Intern 2
 
@@ -456,7 +456,7 @@ Instead, propose that:
 For parity with actions, a `View` would be a constructor which
 takes an `ActionContext` as a parameter (with similarly-defined
 properties) and exposes a method to retrieve the HTML elements
-associateed with it.
+associated with it.
 
 The platform would then additionally expose an `AngularView`
 implementation to improve compatibility with existing

docs/src/design/proposals/APIRedesign_PeteRichards.md

@@ -99,7 +99,7 @@ To reduce interface depth, we can replace our own provider and registry patterns
 
 ## More angular: for all services
 
-Increasing our commitment to angular would mean using more of the angular factorys, services, etc, and less of our home grown tools.  We'd implement our services and extension points as angular providers, and make them configurable via app.config.
+Increasing our commitment to angular would mean using more of the angular factories, services, etc, and less of our home grown tools.  We'd implement our services and extension points as angular providers, and make them configurable via app.config.
 
 As an example, registering a specific type of model provider in angular would look like:
 

docs/src/tutorials/index.md

@@ -3238,7 +3238,7 @@ define(
 __tutorials/telemetry/src/ExampleTelemetryServerAdapter.js__
 
 Here, we have added `subscribe` and `unsubscribe` methods which issue the 
-corresponding requests to the server. Seperately, we introduce the ability to 
+corresponding requests to the server. Separately, we introduce the ability to 
 listen for `data` messages as they come in: These will contain the data associated 
 with these subscriptions.
 

example/eventGenerator/data/transcript.json

@@ -10,7 +10,7 @@
     "LMP: 47 degrees.",
     "CC: Eagle, looking great. You're GO.",
     "CC: Roger. 1202. We copy it.",
-    "O1: LMP 35 degrees. 35 degrees. 750. Coming aown to 23.fl",
+    "O1: LMP 35 degrees. 35 degrees. 750. Coming down to 23.fl",
     "LMP: 700 feet, 21 down, 33 degrees.",
     "LMP: 600 feet, down at 19.",
     "LMP: 540 feet, down at - 30. Down at 15.",

platform/commonUI/dialog/src/DialogService.js

@@ -187,7 +187,7 @@ define(
 
         /**
          * A description of the model options that may be passed to the
-         * showBlockingMessage method. Note that the DialogModel desribed
+         * showBlockingMessage method. Note that the DialogModel described
          * here is shared with the Notifications framework.
          * @see NotificationService
          *

platform/commonUI/edit/test/creation/CreationServiceSpec.js

@@ -195,7 +195,7 @@ define(
                 expect(failure).toHaveBeenCalled();
             });
 
-            it("logs an error when mutaton fails", function () {
+            it("logs an error when mutation fails", function () {
                 // If mutation of the parent fails, we've lost the
                 // created object - this is an error.
                 var model = { someKey: "some value" };

platform/commonUI/edit/test/representers/EditRepresenterSpec.js

@@ -112,7 +112,7 @@ define(
                 expect(mockPersistence.persist).toHaveBeenCalled();
 
                 // Finally, check that the provided mutation function
-                // includes both model and configuratioon
+                // includes both model and configuration
                 expect(
                     mockDomainObject.useCapability.mostRecentCall.args[1]()
                 ).toEqual({

platform/commonUI/edit/test/representers/EditToolbarRepresenterSpec.js

@@ -79,7 +79,7 @@ define(
             it("removes state from parent scope on destroy", function () {
                 // Verify precondition
                 expect(mockScope.$parent.testToolbar).toBeDefined();
-                // Destroy the represeter
+                // Destroy the representer
                 representer.destroy();
                 // Should have removed toolbar state from view
                 expect(mockScope.$parent.testToolbar).toBeUndefined();

platform/commonUI/general/src/controllers/ObjectInspectorController.js

@@ -38,7 +38,7 @@ define(
             $scope.contextutalParents = [];
             //$scope.isLink = false;
 
-            // Gets an array of the contextual parents/anscestors of the selected object
+            // Gets an array of the contextual parents/ancestors of the selected object
             function getContextualPath() {
                 var currentObj = $scope.ngModel.selectedObject,
                     currentParent,
@@ -61,7 +61,7 @@ define(
                 $scope.contextutalParents = parents;
             }
 
-            // Gets an array of the parents/anscestors of the selected object's
+            // Gets an array of the parents/ancestors of the selected object's
             //   primary location (locational of original non-link)
             function getPrimaryPath(current) {
                 var location;

platform/commonUI/general/src/filters/ReverseFilter.js

@@ -25,7 +25,7 @@ define(function () {
     /**
      * Implements the `reverse` filter, which reverses text strings.
      * Useful in cases where text should be reversed for presentational
-     * reasons (e.g. in conjunction with CSS tricks involing text direction),
+     * reasons (e.g. in conjunction with CSS tricks involving text direction),
      * allowing such behavior to be handled independently from the controller
      * layer.
      *

platform/commonUI/general/src/services/PopupService.js

@@ -35,7 +35,7 @@ define(
         }
 
         /**
-         * Options controlling how the popup is displaed.
+         * Options controlling how the popup is displayed.
          *
          * @typedef PopupOptions
          * @memberof platform/commonUI/general

platform/commonUI/general/test/controllers/ClickAwayControllerSpec.js

@@ -60,7 +60,7 @@ define(
                 expect(controller.isActive()).toBe(false);
             });
 
-            it("allows active state to be explictly specified", function () {
+            it("allows active state to be explicitly specified", function () {
                 controller.setState(true);
                 expect(controller.isActive()).toBe(true);
                 controller.setState(true);

platform/commonUI/general/test/controllers/ToggleControllerSpec.js

@@ -46,7 +46,7 @@ define(
                 expect(controller.isActive()).toBe(false);
             });
 
-            it("allows active state to be explictly specified", function () {
+            it("allows active state to be explicitly specified", function () {
                 controller.setState(true);
                 expect(controller.isActive()).toBe(true);
                 controller.setState(true);

platform/commonUI/mobile/test/MCTDeviceSpec.js

@@ -72,7 +72,7 @@ define(
                 expect(directive.restrict).toEqual("A");
             });
 
-            it("transcludes at the elmeent level", function () {
+            it("transcludes at the element level", function () {
                 expect(directive.transclude).toEqual('element');
             });
 

platform/commonUI/notification/src/NotificationService.js

@@ -361,7 +361,7 @@ define(
                  autodismiss specified), leave it to run. Otherwise force a
                   timeout.
 
-                 This notifcation has been added to queue and will be
+                 This notification has been added to queue and will be
                   serviced as soon as possible.
                  */
                 this.active.timeout = this.$timeout(function () {

platform/containment/test/CapabilityTableSpec.js

@@ -45,7 +45,7 @@ define(
                         ['getKey', 'getDefinition', 'getInitialModel']
                     );
                     mockType.getKey.andReturn(type);
-                    // Return a model to drive apparant capabilities
+                    // Return a model to drive apparent capabilities
                     mockType.getInitialModel.andReturn({ id: type });
                     return mockType;
                 });

platform/containment/test/ContainmentTableSpec.js

@@ -50,7 +50,7 @@ define(
                         // third one defines no containership rules
                         contains: (index < 2) ? [{ has: 'b' }] : undefined
                     });
-                    // Return a model to drive apparant capabilities
+                    // Return a model to drive apparent capabilities
                     mockType.getInitialModel.andReturn({ id: type });
                     return mockType;
                 });

platform/core/src/models/ModelCacheService.js

@@ -24,7 +24,7 @@ define([], function () {
 
     /**
      * Provides a cache for domain object models which exist in memory,
-     * but may or may not exist in backing persistene stores.
+     * but may or may not exist in backing persistence stores.
      * @constructor
      * @memberof platform/core
      */

platform/core/src/models/RootModelProvider.js

@@ -42,7 +42,7 @@ define(
          * @implements {ModelService}
          * @param {Array} roots all `roots[]` extensions
          * @param $q Angular's $q, for promises
-         * @param $log Anuglar's $log, for logging
+         * @param $log Angular's $log, for logging
          */
         function RootModelProvider(roots, $q, $log) {
             // Pull out identifiers to used as ROOT's

platform/core/src/models/StaticModelProvider.js

@@ -49,7 +49,7 @@ define(
                 }
             }
 
-            // Prepoulate maps with models to make subsequent lookup faster.
+            // Prepopulate maps with models to make subsequent lookup faster.
             models.forEach(addModelToMap);
 
             this.modelMap = modelMap;

platform/core/src/types/TypePropertyConversion.js

@@ -43,7 +43,7 @@ define(
             },
             ARRAY_SUFFIX = '[]';
 
-        // Utility function to handle arrays of conversiions
+        // Utility function to handle arrays of conversions
         function ArrayConversion(conversion) {
             return {
                 toModelValue: function (formValue) {

platform/core/src/types/TypeProvider.js

@@ -68,7 +68,7 @@ define(
             }) : array;
         }
 
-        // Reduce an array of type definitions to a single type definiton,
+        // Reduce an array of type definitions to a single type definition,
         // which has merged all properties in order.
         function collapse(typeDefs) {
             var collapsed = typeDefs.reduce(function (a, b) {

platform/entanglement/README.md

@@ -3,7 +3,7 @@
 Entanglement is the process of moving, copying, and linking domain objects
 in such a way that their relationships are impossible to discern.
 
-This bundle provides move, copy, and link functionality.  Acheiving a state of 
+This bundle provides move, copy, and link functionality.  Achieving a state of 
 entanglement is left up to the end user.
 
 

platform/features/layout/src/FixedDragHandle.js

@@ -94,7 +94,7 @@ define(
         };
 
         /**
-         * End a drag gesture. This should be callled when a drag
+         * End a drag gesture. This should be called when a drag
          * concludes to trigger commit of changes.
          */
         FixedDragHandle.prototype.endDrag = function () {

platform/features/layout/src/LayoutController.js

@@ -152,7 +152,7 @@ define(
         }
 
         // Convert from { positions: ..., dimensions: ... } to an
-        // apropriate ng-style argument, to position frames.
+        // appropriate ng-style argument, to position frames.
         LayoutController.prototype.convertPosition = function (raw) {
             var gridSize = this.gridSize;
             // Multiply position/dimensions by grid size

platform/features/layout/test/LayoutControllerSpec.js

@@ -164,7 +164,7 @@ define(
                 // Populate scope
                 mockScope.$watchCollection.mostRecentCall.args[1]();
 
-                // Verify precondtion
+                // Verify precondition
                 expect(testConfiguration.panels.b).not.toBeDefined();
 
                 // Do a drag

platform/features/plot/test/Canvas2DChartSpec.js

@@ -59,7 +59,7 @@ define(
                 expect(mock2d.clearRect).toHaveBeenCalled();
             });
 
-            it("doees not construct if 2D is unavailable", function () {
+            it("does not construct if 2D is unavailable", function () {
                 mockCanvas.getContext.andReturn(undefined);
                 expect(function () {
                     return new Canvas2DChart(mockCanvas);

platform/features/plot/test/GLChartSpec.js

@@ -82,7 +82,7 @@ define(
                 expect(mockGL.clear).toHaveBeenCalled();
             });
 
-            it("doees not construct if WebGL is unavailable", function () {
+            it("does not construct if WebGL is unavailable", function () {
                 mockCanvas.getContext.andReturn(undefined);
                 expect(function () {
                     return new GLChart(mockCanvas);

platform/features/timeline/src/controllers/TimelineGanttController.js

@@ -26,7 +26,7 @@ define(
 
         /**
          * Control for Gantt bars in a timeline view.
-         * Primarily reesponsible for supporting the positioning of Gantt
+         * Primarily responsible for supporting the positioning of Gantt
          * bars; particularly, this ensures that the left and right edges
          * never go to far off screen, because in some environments this
          * will effect rendering performance without visible results.

platform/features/timeline/src/controllers/TimelineTickController.js

@@ -28,7 +28,7 @@ define(
 
         /**
          * Provides labels for the tick mark area of a timeline view.
-         * Since the tick mark regin is potentially extremeley large,
+         * Since the tick mark region is potentially extremely large,
          * only the subset of ticks which will actually be shown in
          * view are provided.
          * @constructor

platform/features/timeline/src/controllers/drag/TimelineDragHandler.js

@@ -148,7 +148,7 @@ define(
                     var timespan = timespans[toId(id)];
                     // Use as setter if argument is present
                     if ((typeof value === 'number') && timespan) {
-                        // Set the end (ensuring it doesn't preceed start)
+                        // Set the end (ensuring it doesn't precede start)
                         timespan.setEnd(
                             Math.max(value, timespan.getStart())
                         );

platform/features/timeline/src/controllers/drag/TimelineSnapHandler.js

@@ -41,7 +41,7 @@ define(
                     ids,
                     candidates;
 
-                // Filter an id for inclustion
+                // Filter an id for inclusion
                 function include(id) {
                     return id !== exclude;
                 }

platform/framework/src/load/Bundle.js

@@ -174,7 +174,7 @@ define(
          * category.
          *
          * @param {string} category name of the extension category
-         * @returns {Array} extension definitions of that cataegory
+         * @returns {Array} extension definitions of that category
          */
         Bundle.prototype.getExtensions = function (category) {
             var extensions = this.definition.extensions[category] || [],

platform/persistence/couch/src/CouchDocument.js

@@ -27,7 +27,7 @@ define(
         /**
          * A CouchDocument describes domain object model in a format
          * which is easily read-written to CouchDB. This includes
-         * Couch's _id and _rev fields, as well as a sseparate
+         * Couch's _id and _rev fields, as well as a separate
          * metadata field which contains a subset of information found
          * in the model itself (to support search optimization with
          * CouchDB views.)
@@ -37,7 +37,7 @@ define(
          * @param {object} model the model to store
          * @param {string} rev the revision to include (or undefined,
          *        if no revision should be noted for couch)
-         * @param {boolean} whether or not to mark this documnet as
+         * @param {boolean} whether or not to mark this document as
          *        deleted (see CouchDB docs for _deleted)
          */
         function CouchDocument(id, model, rev, markDeleted) {

platform/persistence/couch/test/CouchIndicatorSpec.js

@@ -69,7 +69,7 @@ define(
                     initialDescrption = indicator.getDescription(),
                     initialGlyphClass = indicator.getGlyphClass();
 
-                // Nominal just means getting back an objeect, without
+                // Nominal just means getting back an object, without
                 // an error field.
                 mockPromise.then.mostRecentCall.args[0]({ data: {} });
 
@@ -88,7 +88,7 @@ define(
                     initialDescrption = indicator.getDescription(),
                     initialGlyphClass = indicator.getGlyphClass();
 
-                // Nominal just means getting back an objeect, with
+                // Nominal just means getting back an object, with
                 // an error field.
                 mockPromise.then.mostRecentCall.args[0](
                     { data: { error: "Uh oh." } }
@@ -110,7 +110,7 @@ define(
                     initialDescrption = indicator.getDescription(),
                     initialGlyphClass = indicator.getGlyphClass();
 
-                // Nominal just means getting back an objeect, without
+                // Nominal just means getting back an object, without
                 // an error field.
                 mockPromise.then.mostRecentCall.args[1]({ data: {} });
 

platform/persistence/elastic/src/ElasticSearchProvider.js

@@ -51,7 +51,7 @@ define([
      * Search for domain objects using elasticsearch as a search provider.
      *
      * @param {String} searchTerm the term to search by.
-     * @param {Number} [maxResults] the max numer of results to return.
+     * @param {Number} [maxResults] the max number of results to return.
      * @returns {Promise} promise for a modelResults object.
      */
     ElasticSearchProvider.prototype.query = function (searchTerm, maxResults) {