From bbc25edc5422414f9f8dab3111b9a8635b58fc27 Mon Sep 17 00:00:00 2001 From: H1Gdev Date: Thu, 21 Feb 2019 17:13:34 +0900 Subject: [PATCH 1/2] Fix typo in docs. --- CONTRIBUTING.md | 2 +- GUIDELINES.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aaf9c998..c6ed1e5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ The [issue tracker](https://github.com/gopro/forgejs/issues) is the best place t - Consult the list of things that **won't** be implemented. - Read up on what type of feature requests are accepted. - See if anybody has not requested the feature yet. -- If it hasn't beed requested yet, submit a new request as an issue. +- If it hasn't been requested yet, submit a new request as an issue. ### Submitting a pull-request diff --git a/GUIDELINES.md b/GUIDELINES.md index 4fdf9dfd..0bdad5ba 100644 --- a/GUIDELINES.md +++ b/GUIDELINES.md @@ -29,7 +29,7 @@ The following annotations are those which matter the most when using the compile ### Available types -All built-in types can be used in the JSDoc, along with all declared types of ForgeJS. But there is a trap with the built-in types: a `number` is not the same as a `Number` (note the capitalized N). The first one is only a value, while the latter is an Object. They don't represent at all the same thing for the compiler, so be aware of capitalized type. This constraint don't exist with the ForgeJS objects. +All built-in types can be used in the JSDoc, along with all declared types of ForgeJS. But there is a trap with the built-in types: a `number` is not the same as a `Number` (note the capitalized N). The first one is only a value, while the latter is an Object. They don't represent at all the same thing for the compiler, so be aware of capitalized type. This constraint doesn't exist with the ForgeJS objects. If a type is missing, like a custom Object (for example, special JSON format), it can be declared as follows : @@ -47,7 +47,7 @@ A missing type can be added in the appropriate file in `externs/forge`. In order ## Reference -Everytime the structure of the `config.json` changes, it needs to be updated in the appropriate file in `reference/`. It can be either adding new properties to an object, or adding a new object. This reference follows the [JSON Schema](http://json-schema.org/), a xsd-like document to describe and annotate JSON documents. +Every time the structure of the `config.json` changes, it needs to be updated in the appropriate file in `reference/`. It can be either adding new properties to an object, or adding a new object. This reference follows the [JSON Schema](http://json-schema.org/), a xsd-like document to describe and annotate JSON documents. ### Describing a property @@ -71,7 +71,7 @@ In the field `properties` of the object to edit, there are an object for each pr } ``` -Beside the key of the property, corresponding to the one that will be present in the `config.json` file, a property is constitued essentially of these four properties : +Beside the key of the property, corresponding to the one that will be present in the `config.json` file, a property is constituted essentially of these four properties : - `type` can be `string`, `number`, `boolean`, or more complex values - `title` is the name of the property appearing in the documentation @@ -101,7 +101,7 @@ A new object is added to its relevant folder, in `reference/`. The structure is - `id` is the identifier of the object - `$schema` is the JSON Schema reference - `title` is the name of the object, as used in the sources (with the `@type` tag) -- `description` is the description appearing in the documention +- `description` is the description appearing in the documentation - `type` is always `object` Properties are then added as described above. @@ -121,7 +121,7 @@ When describing a property being another object, add the reference as follows, w -## Others recommandations +## Others recommendations ### Inline implicit cast @@ -245,7 +245,7 @@ Do not comment big chunk of code, as "archive" or "backup". Either use the `@dep ### `Object.defineProperty` and `@this` -When using the `Object.defineProperty` on a class, in case the `this` keyword is used, the `getter` and `setter` should be preceded by the `@this` annotation like this, mentionning the class the property is being defined on : +When using the `Object.defineProperty` on a class, in case the `this` keyword is used, the `getter` and `setter` should be preceded by the `@this` annotation like this, mentioning the class the property is being defined on : ```js /** From 46cd06b63eca0dd912ede87ea6445e97aa120a96 Mon Sep 17 00:00:00 2001 From: H1Gdev Date: Mon, 25 Feb 2019 11:00:54 +0900 Subject: [PATCH 2/2] Fix the same typo. --- reference/scene/scene-media-source.json | 2 +- src/media/MediaStore.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/scene/scene-media-source.json b/reference/scene/scene-media-source.json index b905b1d5..7e545635 100644 --- a/reference/scene/scene-media-source.json +++ b/reference/scene/scene-media-source.json @@ -52,7 +52,7 @@ "order": { "type": "string", "title": "Order", - "description": "Order of the layout in the cubemap media, ie where are the faces in the media, starting from the top left of the media. Needs to be a 6-char string, constitued with all of the following letter: ", + "description": "Order of the layout in the cubemap media, ie where are the faces in the media, starting from the top left of the media. Needs to be a 6-char string, constituted with all of the following letter: ", "default": "RLUDBF" }, diff --git a/src/media/MediaStore.js b/src/media/MediaStore.js index 514e6d67..996796be 100644 --- a/src/media/MediaStore.js +++ b/src/media/MediaStore.js @@ -40,7 +40,7 @@ FORGE.MediaStore = function(viewer, config, preview) this._preview = preview; /** - * A map containing all {@link FORGE.MediaTexture}, with the key being constitued + * A map containing all {@link FORGE.MediaTexture}, with the key being constituted * from the level, face, x and y properties defining the texture * @name FORGE.MediaStore#_textures * @type {?FORGE.Map}