Update docs for integrals in Toolkit 1.11 #1653
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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-sv-toolkit-1-11 |
syvb
force-pushed
the
sv/toolkit-1-11
branch
from
3d36695 to
1ef5432
Compare
charislam
approved these changes
Sep 27, 2022
Contributor
charislam
left a comment
charislam
left a comment
There was a problem hiding this comment.
Looks great! Some minor nits, mostly non-blocking
| |-|-|-| | ||
| |`prev`|`TimeWeightSummary`|The TimeWeightSummary from the prior interval, used to interpolate the value at `start`. If `NULL`, the first timestamp in `tws` will be used as the start of the interval.| | ||
| |`next`|`TimeWeightSummary`|The TimeWeightSummary from the following interval, used to interpolate the value at `start` + `interval`. If `NULL`, the last timestamp in `tws` will be used as the end of the interval.| | ||
| |`prev`|`TimeWeightSummary`|The TimeWeightSummary from the prior interval, used to interpolate the value at `start`. If `NULL`, the first timestamp in `tws` is used as the start of the interval.| |
Contributor
There was a problem hiding this comment.
I really, really appreciate that you're following the linter guidelines! 🙌🏼
Comment on lines
+26
to
+30
| Time weighted integrals are useful when you need a time-weighted sum of | ||
| irregularly sampled data. For example, if you bill your users based on | ||
| irregularly sampled CPU usage, you need to find the total area under the graph | ||
| of their CPU usage. You can use a time-weighted integral to find the total | ||
| CPU-hours used by a user over a given time period. |
Contributor
There was a problem hiding this comment.
This is great! Love the real-world example
Loquacity
approved these changes
Sep 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates documentation for the addition of
integral/interpolated_integralin Toolkit 1.11. I based the content for these based onaverage/interpolated_average, since the functions are very similar.Writing help
For information about style and word usage, see the style guide
Review checklists
Reviewers: use this section to ensure you have checked everything before approving this PR:
Subject matter expert (SME) review checklist
Documentation team review checklist
and have they been implemented?