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.

Sign up for GitHub

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

Jump to bottom

Doc Strings #43

Open

Marsha331 opened this issue Nov 21, 2018 · 1 comment

Assignees

Collaborator

Marsha331 commented Nov 21, 2018 •

edited by E-A-N

Loading

Use JS doc for docstrings

Ean's example for his const thaiFood = (SideOrder)

\** 
    * @param {object} sideOrder : Name of food item to check availability for.
    * @returns {boolean} 
*/
const thaiFood = (siderOrder) => {
    var isAvailbile = (sideOrder.isAvailible === true);
    return isAvailible
}

Edit (Ean): correcting syntax

Marsha331 assigned qwertypie90 and sugarsyntax

Collaborator

E-A-N commented Nov 21, 2018

Hey @sugarsyntax @qwertypie90 you all are doing a great job with the doc strings! Some notes:

Keep your branch updated with the current state of Master Branch in the repository
Your branch "docStrings" is 62 commits behind, try to pull from the Master so you're up to speed with changes in our game.
There will be conflicts so be ready to resolve them.
If you need any assistance don't hesitate to ping me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment