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

Google documentation headline missing arguments #5307

Open
AAlex-11 opened this issue May 2, 2024 · 1 comment
Open

Google documentation headline missing arguments #5307

AAlex-11 opened this issue May 2, 2024 · 1 comment
Labels
type: docs Improvement to the documentation for an API. type: process A process-related concern. May include testing, release, or the like.

Comments

@AAlex-11
Copy link

AAlex-11 commented May 2, 2024

Can Google developer illustrate documentation for one example for each API. for example

 node cloud_tasks.create_task.js Argument1 Argument2 Argument3 

Give please for developer CONCRETE WORKABLE EXAMPLE for Argument1 Argument2 Argument3

CloudTask-05032024_001847

@sofisl sofisl changed the title Google documentation look as unusefull trash, because any concrete workable argument example missing Google documentation missing arguments May 8, 2024
@sofisl sofisl added type: process A process-related concern. May include testing, release, or the like. type: docs Improvement to the documentation for an API. labels May 8, 2024
@sofisl
Copy link
Contributor

sofisl commented May 8, 2024

Hi @AAlex-11, thanks for bringing this to our attention - I agree it would be better to include the arguments in the README. However, as a workaround, we do actually have information on the arguments in the sample itself. See for example:

* Required. The location name in which the queue will be created.
* For example: `projects/PROJECT_ID/locations/LOCATION_ID`
* The list of allowed locations can be obtained by calling Cloud
* Tasks' implementation of
* ListLocations google.cloud.location.Locations.ListLocations.
*/
// const parent = 'abc123'
/**
* Required. The queue to create.
* Queue's name google.cloud.tasks.v2.Queue.name cannot be the same as an
* existing queue.
*/
// const queue = {}
. We also have handwritten samples here: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/main/cloud-tasks/snippets.

Also, I've renamed the title of your message - please kindly make sure to follow our community guidelines!

@sofisl sofisl changed the title Google documentation missing arguments Google documentation headline missing arguments May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API. type: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Development

No branches or pull requests

2 participants