docs icon indicating copy to clipboard operation
docs copied to clipboard

[Feedback] Page: /api/latest/informational-views/jobs/

Open deasthamgp opened this issue 1 year ago • 2 comments

Is it easy to find the information you need?

No

Are the instructions clear?

No

How could we improve the Timescale documentation site?

Why is none of your documentation annotated? Example: the jobs table... you list out the table definition of columns and what they mean... but then you fail to describe what specific default values might mean. Such as... what is the behavior when max_runtime is 00:00:00 ?? Is that infinite? Is that, the job will never run because it's not allowed more than 0 Hrs/Mins/Secs seconds to run? Is max_retries == -1 equivalent to infinite? Or is this a bad value to use?

Please elaborate on your documentation. Thank you.

deasthamgp avatar Jul 30 '24 14:07 deasthamgp

Thank you for the report. We welcome documentation contributions!

  • For information about how to propose a change, see the contributing guide in our GitHub repository.
  • For information on style and word usage, see the style guide

github-actions[bot] avatar Jul 30 '24 14:07 github-actions[bot]

Hi @deasthamgp, thanks for reporting! Very important info.

I think you just guessed the default behavior of both.

In the case of intervals, a zero interval is just "disable" the feature.

While, max_retries as -1 is just the default in case you're not using any value.

Hey @mkindahl, is there any other learnings we can have from these defaults?

jonatas avatar Aug 05 '24 20:08 jonatas