Document the Exclude (incomplete periods) control in reports - #141
Draft
claude[bot] wants to merge 2 commits into
Draft
Document the Exclude (incomplete periods) control in reports#141claude[bot] wants to merge 2 commits into
claude[bot] wants to merge 2 commits into
Conversation
Updated section title for clarity on data exclusion.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Confidence Score: 5/5The documentation-only change appears safe to merge. The new section is additive, valid MDX, and clearly describes the Exclude control without disrupting existing documentation.
|
| Filename | Overview |
|---|---|
| docs/reports.mdx | Adds concise documentation for excluding incomplete reporting periods; no actionable issue identified. |
Reviews (1): Last reviewed commit: "Change section title to 'Excluding Perio..." | Re-trigger Greptile
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
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.
Requested by Ross Gonsolvis · Slack thread
Before / After
Before: The report toolbar's Exclude dropdown — which drops still-in-progress time periods (today, current week/month/quarter, or any incomplete period for the chart's time unit) so partial data doesn't skew trends and aggregates — was entirely undocumented. The Date Range documentation even states that ranges include the current, incomplete day, giving readers no indication that this data could be excluded.
After: A new Excluding Incomplete Periods section in
reports.mdxdocuments the Exclude control, explains why excluding partial periods avoids misleading dips and spikes, and lists each option (Today, Current week, Current month, Current quarter, Incomplete periods). It notes the feature is available across all core reports.How
Added a new
## Excluding Incomplete Periodssection todocs/reports.mdx, placed immediately after the Comparisons section and before Saving to a board. The heading level (##) and bold/list formatting match the surrounding sibling sections. This is a single-file, additive change.