Skip to content
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.

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

Bucket#upload() options don't show up in documentation #75

Closed
jmdobry opened this issue Nov 1, 2017 · 4 comments
Closed

Bucket#upload() options don't show up in documentation #75

jmdobry opened this issue Nov 1, 2017 · 4 comments
Assignees
Labels
api: storage Issues related to the googleapis/nodejs-storage API. docs 🚨 This issue needs some love. triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@jmdobry
Copy link
Contributor

jmdobry commented Nov 1, 2017

The options are documented in the source code, but for some reason don't show up on cloud.google.com

@stephenplusplus
Copy link
Contributor

That seems to be the case for all methods on Bucket. I don't know the spec on this, but maybe marking options as optional is enough, and it would be implied that options.* is optional. In diff:

 * @param {object} [options] Configuration options.
- * @param {string|File} [options.destination] The place to save
+ * @param {string|File} options.destination The place to save

@jmdobry
Copy link
Contributor Author

jmdobry commented Nov 1, 2017

I don't think that's the problem. When you run npm run docs locally and it uses the docstrap template, these options all show up fine in the generated docs. But when we generate the docs using our custom template on cloud.google.com, the options are missing. It must be a problem with the template we use on cloud.google.com.

@stephenplusplus stephenplusplus added docs type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Nov 3, 2017
@lukesneeringer lukesneeringer added the priority: p2 Moderately-important priority. Fix may not be included in next release. label Nov 10, 2017
@stephenplusplus
Copy link
Contributor

Does another team need to take a look into why these aren't showing up?

@stephenplusplus
Copy link
Contributor

This issue was moved to googleapis/google-cloud-node#2783.

@ghost ghost removed the priority: p2 Moderately-important priority. Fix may not be included in next release. label Dec 22, 2017
@google-cloud-label-sync google-cloud-label-sync bot added the api: storage Issues related to the googleapis/nodejs-storage API. label Jan 31, 2020
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/nodejs-storage API. docs 🚨 This issue needs some love. triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

4 participants