Add documentation #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gtfs.js
Outdated
| * | ||
| * @param {Array<Object>} items Array of item to add to the GTFS. | ||
| * @param {string} tableName Name of the table of the GTFS in which the objects should be added. | ||
| * @param {Object} gtfs GTFS object in which to add the items. |
There was a problem hiding this comment.
Don't usually you want the object you are modifying to be the first instead of last? If you don't have an actual gifts object (sorry this is not really related to documentation).
gtfs.js
Outdated
| /** | ||
| * Table-generic function to add items in a table of a GTFS. | ||
| * | ||
| * @param {Array<Object>} items Array of item to add to the GTFS. |
gtfs.js
Outdated
| * Table-generic function to get an indexed table of a GTFS. The indexation depends of the table, and is defined in | ||
| * the schema (If possible, it is the unique id). | ||
| * | ||
| * @param {string} tableName Name of the table of the GTFS to get. |
There was a problem hiding this comment.
will it work if the table name is invalid?
gtfs.js
Outdated
| @@ -35,6 +43,16 @@ function addItems(items, tableName, gtfs) { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * Table-generic function to get an indexed table of a GTFS. The indexation depends of the table, and is defined in | |||
| * the schema (If possible, it is the unique id). | |||
gtfs.js
Outdated
| * Table-generic function to add items in a table of a GTFS. | ||
| * | ||
| * @param {Array<Object>} items Array of item to add to the GTFS. | ||
| * @param {string} tableName Name of the table of the GTFS in which the objects should be added. |
There was a problem hiding this comment.
will it work if the name of the table is not valid?
gtfs.js
Outdated
| /** | ||
| * Constructor of the GTFS | ||
| * | ||
| * @param {string} path Path to the folder contains the GTFS text files. |
There was a problem hiding this comment.
path to the folder that contains the GTFS...?
gtfs.js
Outdated
| * Constructor of the GTFS | ||
| * | ||
| * @param {string} path Path to the folder contains the GTFS text files. | ||
| * @param {Object|undefined} regexPatternObjectsByTableName Optional ad-hoc regex to fix the tables. See importTable. |
There was a problem hiding this comment.
to fix how? see what about importTable ?
gtfs.js
Outdated
| /** | ||
| * Async function exporting the GTFS at a specific path. | ||
| * | ||
| * @param {string} path Path to the folder which will contains the GTFS. The folder will be created if needed. |
annaelleduff
approved these changes
Jan 15, 2018
helpers/import.js
Outdated
| * | ||
| * @param {Gtfs} gtfs The GTFS in which to import the table. | ||
| * @param {string} tableName The table of the name to import. | ||
| * @param { |
There was a problem hiding this comment.
Does this work? (does webstorm parse it / did you try to validate it against a jsdoc validator?)
There was a problem hiding this comment.
webstorm does parse it, and give advices based on that. Indeed GitHub seems to not like it.
quentin-sommer
approved these changes
Jan 15, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.