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

Mini Bug: Minor docs update (options.body) #16

Open

simenfossnes opened this issue May 4, 2020 · 0 comments

simenfossnes commented May 4, 2020 •

edited

Loading

Currently, it generated this:

/**
 * @param {Object} options
 * @throws {Error}
 * @return {Promise}
 */

To make it clear how to access the body property, it could be updated to look like this:

/**
 * @param {Object} options
 * @param {Object} options.body The request body.
 * @throws {Error}
 * @return {Promise}
 */

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