docs: add documentation for timeseries#83
Conversation
📝 WalkthroughWalkthroughUpdated English and Russian public API docs to describe timeseries-capable aggregations, note AGG_FUNC_UNIQUE is not supported in timeseries, and add COUNT-with-interval request/response examples (duplicated in each doc). Minor formatting adjustment (trailing newline). Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Assessment against linked issues
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
docs/ru/10-public-api.md (2)
182-182: Wording and terminology: replace “таймсерии” and fix agreementUse the standard Russian term and tighten the phrasing.
-Полям документов, соответствующим запросу. Также агрегации поддерживают вычисление статистических значений среди различных временных интервалов (также известные как таймсерии). +полям документов, соответствующим запросу. Также агрегации поддерживают вычисление статистических значений по различным временным интервалам (временные ряды, time series).
199-199: Consistency: “таймсерий” → “тайм-серий” (or use “временных рядов”)Use consistent terminology and correct hyphenation.
-- `AGG_FUNC_UNIQUE` — вычисление уникальных значений поля (не поддерживается для вычисления таймсерий) +- `AGG_FUNC_UNIQUE` — вычисление уникальных значений поля (не поддерживается для тайм-серий)docs/en/10-public-api.md (2)
182-182: Minor wording: “timeseries” → “time series”; streamline phrasingSmall editorial polish for readability.
-that match the query. Also aggregations support computation of statistical values within different time intervals (also known as timeseries). +that match the query. Aggregations also support computing statistical values across time intervals (also known as time series).
198-199: Clarify scope: UNIQUE not supported “for time-series aggregations”This is a bit clearer than “in timeseries”.
-- `AGG_FUNC_UNIQUE` — computation of unique field values (not supported in timeseries) +- `AGG_FUNC_UNIQUE` — computation of unique field values (not supported for time-series aggregations)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/en/10-public-api.md(4 hunks)docs/ru/10-public-api.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/ru/10-public-api.md
[grammar] ~182-~182: Ensure spelling is correct
Context: ...и различных временных интервалов (также известные как таймсерии). Агрегации можно вызыва...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/ru/10-public-api.md (1)
444-491: COUNT-with-interval example: JSON and headings look correct now.Trailing/missing commas are fixed, and headings localized to Russian. The interval usage and ts stepping are coherent.
🧹 Nitpick comments (1)
docs/ru/10-public-api.md (1)
182-182: Fix grammatical agreement and terminology (“тайм‑серии”).Parenthetical should agree with “временных интервалов” and use the standard term.
Apply this diff:
- полям документов, соответствующим запросу. Также агрегации поддерживают вычисление статистических значений среди различных временных интервалов (также известные как таймсерии). + полям документов, соответствующим запросу. Также агрегации поддерживают вычисление статистических значений среди различных временных интервалов (также известных как тайм-серии).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/en/10-public-api.md(4 hunks)docs/ru/10-public-api.md(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/en/10-public-api.md
🧰 Additional context used
🪛 LanguageTool
docs/ru/10-public-api.md
[grammar] ~182-~182: Ensure spelling is correct
Context: ...и различных временных интервалов (также известные как таймсерии). Агрегации можно вызыва...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (1)
docs/ru/10-public-api.md (1)
199-199: Good clarification about UNIQUE in time series.Explicitly noting that AGG_FUNC_UNIQUE isn’t supported for time-series is helpful and prevents misuse.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #83 +/- ##
==========================================
+ Coverage 73.44% 73.46% +0.01%
==========================================
Files 193 193
Lines 16015 16015
==========================================
+ Hits 11762 11765 +3
+ Misses 3662 3660 -2
+ Partials 591 590 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
4 participants
Closes #82
Summary by CodeRabbit