Skip to content

[No QA] update JSDoc for API.js functions#9558

Merged
marcochavezf merged 19 commits into
mainfrom
marco-jsdoc-API.js
Jun 24, 2022
Merged

[No QA] update JSDoc for API.js functions#9558
marcochavezf merged 19 commits into
mainfrom
marco-jsdoc-API.js

Conversation

@marcochavezf

@marcochavezf marcochavezf commented Jun 24, 2022

Copy link
Copy Markdown
Contributor

cc @aldo-expensify @tgolen

Details

Coming from this comment #9536 (comment), this PR adds JSDoc description and function signatures to the API.js functions.

Fixed Issues

N/A

Tests

N/A

PR Review Checklist

N/A

QA Steps

N/A

@marcochavezf marcochavezf requested a review from a team as a code owner June 24, 2022 12:58
@marcochavezf marcochavezf self-assigned this Jun 24, 2022
@melvin-bot melvin-bot Bot requested review from madmax330 and removed request for a team June 24, 2022 12:58

@madmax330 madmax330 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, just some small comments

Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
@madmax330 madmax330 requested a review from tgolen June 24, 2022 14:24
tgolen
tgolen previously requested changes Jun 24, 2022

@tgolen tgolen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Love the improvements! I left some suggestions which makes it a little more clear and removes some redundant and non-valuable information (like repeating the method name).

Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
Comment thread src/libs/API.js Outdated
marcochavezf and others added 11 commits June 24, 2022 10:59
Co-authored-by: Tim Golen <tgolen@gmail.com>
Co-authored-by: Tim Golen <tgolen@gmail.com>
Co-authored-by: Tim Golen <tgolen@gmail.com>
Co-authored-by: Tim Golen <tgolen@gmail.com>
Co-authored-by: Tim Golen <tgolen@gmail.com>
Co-authored-by: Tim Golen <tgolen@gmail.com>
Co-authored-by: Tim Golen <tgolen@gmail.com>
@marcochavezf

Copy link
Copy Markdown
Contributor Author

Cool, thanks for the suggestions! I updated again the JSDoc of the API.js functions

@marcochavezf marcochavezf requested review from madmax330 and tgolen June 24, 2022 16:24
tgolen
tgolen previously approved these changes Jun 24, 2022
@tgolen tgolen requested review from AndrewGable and marcaaron June 24, 2022 16:29
@marcochavezf marcochavezf dismissed tgolen’s stale review June 24, 2022 16:33

requested changes addressed

marcaaron
marcaaron previously approved these changes Jun 24, 2022

@aldo-expensify aldo-expensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just a small thing!

Comment thread src/libs/API.js Outdated
@marcochavezf marcochavezf dismissed stale reviews from marcaaron and tgolen via d8588b4 June 24, 2022 16:53
@marcochavezf marcochavezf dismissed aldo-expensify’s stale review June 24, 2022 17:08

requested change addressed

aldo-expensify
aldo-expensify previously approved these changes Jun 24, 2022
aldo-expensify
aldo-expensify previously approved these changes Jun 24, 2022
AndrewGable
AndrewGable previously approved these changes Jun 24, 2022

@AndrewGable AndrewGable left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good! One suggestion.

Comment thread src/libs/API.js Outdated
Co-authored-by: Andrew Gable <andrew@expensify.com>
@marcochavezf marcochavezf merged commit 406040d into main Jun 24, 2022
@marcochavezf marcochavezf deleted the marco-jsdoc-API.js branch June 24, 2022 22:29
@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by @marcochavezf in version: 1.1.79-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify

OSBotify commented Jul 8, 2022

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by @roryabraham in version: 1.1.79-17 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants