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

[docs] Cloud Tasks: description needed for scheduleTime #3808

Open
gregfenton opened this issue Dec 21, 2022 · 0 comments
Open

[docs] Cloud Tasks: description needed for scheduleTime #3808

gregfenton opened this issue Dec 21, 2022 · 0 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@gregfenton
Copy link

Environment details

  • OS: n/a
  • Node.js version: all
  • npm version: all
  • google-cloud-node version: all

Steps to reproduce

The docs for Cloud Tasks do not give a description of what the meaning or (more importantly) value of scheduleTime is. There are several identical copies of code snippets in the examples, but it is not at all obvious what day/time/epoch the task is being scheduled for:

  if (inSeconds) {
    task.scheduleTime = {
      seconds: inSeconds + Date.now() / 1000,
    };
  }

unclear to me what seconds: 1671593022.414 (approximately, depending on when Date.now() is for you) means when it gets passed to client.createTask()

Would be very helpful to at least have a comment above each setting in each code sample. But a proper API document is required (if it exists, I am missing which link to follow).

@bcoe bcoe added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. and removed type: docs Improvement to the documentation for an API. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.
2 participants