Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Add jsdoc for filteredArray widget function #611

Merged
merged 8 commits into from
Apr 11, 2017
Merged

Add jsdoc for filteredArray widget function #611

merged 8 commits into from
Apr 11, 2017

Conversation

thevoiceofzeke
Copy link
Contributor

Found something that uses this function while editing entity files -- figured I should explain why it's in this controller in the first place!

Copy link
Contributor

@vertein vertein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hate TODO's in code...

Copy link
Contributor

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
👍 for JSDocs in general

* @param array The array to filter
* @param objectVar The array entry to search through
* @param strings The string values to test against each entry
* @returns {*} An array containing only the desired
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe jsdoc type annotations could help?

/**
 * @param {Array<Object>} array The array to filter
 * @param {Object} objectVar The array entry to search through
 * @param {Array<String>} strings The string values to test against each entry
 * @returns {Array<Object>} An array containing only the desired
 */

@thevoiceofzeke thevoiceofzeke merged commit ddfb6e9 into uPortal-Attic:master Apr 11, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants