Skip to content

Move optional args to optional arg table #2838

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

Merged
merged 3 commits into from
Nov 24, 2023

Conversation

jamessewell
Copy link
Contributor

resolves #2807

Copy link

Allow 10 minutes from last push for the staging site to build. If the link doesn't work, try using incognito mode instead. For internal reviewers, check web-documentation repo actions for staging build status. Link to build for this PR: http://docs-dev.timescale.com/docs-js-compression_policy_args

@jamessewell jamessewell requested a review from jonatas November 21, 2023 08:00
Also change heading levels
@jamessewell jamessewell enabled auto-merge (squash) November 21, 2023 08:28

|Name|Type|Description|
|-|-|-|
|`schedule_interval`|INTERVAL|The interval between the finish time of the last execution and the next start. Defaults to 12 hours for hyper tables with a `chunk_time_interval` >= 1 day and `chunk_time_interval / 2` for all other hypertables.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`schedule_interval`|INTERVAL|The interval between the finish time of the last execution and the next start. Defaults to 12 hours for hyper tables with a `chunk_time_interval` >= 1 day and `chunk_time_interval / 2` for all other hypertables.|
|`schedule_interval`|INTERVAL|The interval between the finish time of the last execution and the next start. Defaults to 12 hours for hypertables with a `chunk_time_interval` >= 1 day and `chunk_time_interval / 2` for all other hypertables.|

Copy link
Contributor

@jonatas jonatas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good, just a small suggestion. I think we should make the default value a column and avoid using it in different parts of the description for the optional arguments table.

@jamessewell jamessewell merged commit 0af6f29 into latest Nov 24, 2023
@jamessewell jamessewell deleted the js/compression_policy_args branch November 24, 2023 00:09
@jamessewell
Copy link
Contributor Author

Very good, just a small suggestion. I think we should make the default value a column and avoid using it in different parts of the description for the optional arguments table.

Yeah I think we can address this when we revamp docs. Good idea.

I think optional and requried could be in the same table as well tbh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Site Bug] Issue with the page: /api/latest/compression/add_compression_policy/
2 participants