Skip to content
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

Fix typo in docs. #173

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 :

Expand All @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -121,7 +121,7 @@ When describing a property being another object, add the reference as follows, w



## Others recommandations
## Others recommendations

### Inline implicit cast

Expand Down Expand Up @@ -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
/**
Expand Down
2 changes: 1 addition & 1 deletion reference/scene/scene-media-source.json
Original file line number Diff line number Diff line change
Expand Up @@ -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: <ul><li>R for Right</li><li>L for Left</li><li>U for Up</li><li>D for Down</li><li>B for Back</li><li>F for Front</li></ul>",
"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: <ul><li>R for Right</li><li>L for Left</li><li>U for Up</li><li>D for Down</li><li>B for Back</li><li>F for Front</li></ul>",
"default": "RLUDBF"
},

Expand Down
2 changes: 1 addition & 1 deletion src/media/MediaStore.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down