feat: adds interval type docs #1021
Conversation
|
@v0y4g3r Please take a look. |
Deploying greptime-docs with
|
| Latest commit: |
81417ef
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8397d2ab.greptime-docs.pages.dev |
| Branch Preview URL: | https://feature-interval-type.greptime-docs.pages.dev |
|
Warning Rate limit exceeded@nicecui has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 45 minutes and 32 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe recent updates to the documentation include the introduction of an Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration 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: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/nightly/en/reference/sql/data-types.md (1 hunks)
- docs/nightly/zh/reference/sql/data-types.md (1 hunks)
Additional context used
LanguageTool
docs/nightly/en/reference/sql/data-types.md
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...8 Bytes | |Float32| 32-bit IEEE754 floating point values | 4 Bytes | |Float64| Doubl...
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...Float64| Double precision IEEE 754 floating point values | 8 Bytes | ## Decimal Type Gr...
[uncategorized] ~77-~77: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...nit [quantity unit...] ``` *quantity: is a number (possibly signed), * `unit...
Additional comments not posted (4)
docs/nightly/zh/reference/sql/data-types.md (2)
66-66: ** Interval Type Introduction**The addition of the
Intervaldata type with detailed size specifications for each sub-type (YearMonth,DayTime,MonthDayNano) is well-documented and aligns with the PR objectives to introduce this new type.
68-138: ** Detailed Explanation and Examples for Interval Type**The comprehensive description and examples provided for the
Intervaltype are clear and informative. The examples effectively illustrate how to use the interval type in SQL queries, and the mention of the unsupported ISO 8601 format is a useful note for users.docs/nightly/en/reference/sql/data-types.md (2)
67-67: ** Interval Type Introduction**The introduction of the
Intervaltype in the English documentation mirrors the structure and content of the Chinese version, maintaining consistency across localized versions. The detailed byte size specifications for each sub-type are correctly noted.
69-139: ** Detailed Explanation and Examples for Interval Type**The section on the
Intervaltype in the English documentation is well-written, providing a clear explanation and practical examples. This should help users understand and utilize theIntervaltype effectively in their SQL queries.Tools
LanguageTool
[uncategorized] ~77-~77: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...nit [quantity unit...] ``` *quantity: is a number (possibly signed), * `unit...
|
A few minor comments, overall LGTM! |
Co-authored-by: Eugene Tolbakov <ev.tolbakov@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/nightly/en/reference/sql/data-types.md (1 hunks)
- docs/nightly/zh/reference/sql/data-types.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/nightly/zh/reference/sql/data-types.md
Additional context used
LanguageTool
docs/nightly/en/reference/sql/data-types.md
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...8 Bytes | |Float32| 32-bit IEEE754 floating point values | 4 Bytes | |Float64| Doubl...
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...Float64| Double precision IEEE 754 floating point values | 8 Bytes | ## Decimal Type Gr...
[uncategorized] ~77-~77: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...NIT [QUANTITY UNIT...] ``` *QUANTITY: is a number (possibly signed), * `UNIT...
Additional comments not posted (2)
docs/nightly/en/reference/sql/data-types.md (2)
71-76: Revise the explanation of theIntervaltype syntax.The explanation of how to write the
Intervaltype is clear, but the example provided immediately after the explanation (QUANTITY UNIT [QUANTITY UNIT...]) is in a code block which might lead to confusion as it appears to be a command rather than a syntax pattern.- ``` - QUANTITY UNIT [QUANTITY UNIT...] - ``` + The syntax for writing intervals is as follows: QUANTITY UNIT [QUANTITY UNIT...]
141-153: Validate shorthand forms and signed numbers examples.The examples for shorthand forms and signed numbers are helpful. However, ensuring that these examples are tested and accurately reflect the output in GreptimeDB would prevent potential user confusion.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
@killme2008 @tisonkun |
Of course, we need to change it too. Do you want to do it? Or let me do it. |
What's Changed in this PR
As the title said. Also for GreptimeTeam/greptimedb#4182
And close #486
Checklist
summary.ymlmatches the current document structure when you changed the document structure.Summary by CodeRabbit
Intervaltype to track time durations in GreptimeDB, available in both English and Chinese.