document new temporal datatypes #167
Conversation
WalkthroughA new section on Temporal Types has been added to the FalkorDB data types documentation. This section introduces and explains the Date, Time, DateTime, and Duration types, detailing their ISO 8601 formats, usage, supported operations, and Cypher query examples. No code or API changes were made. Changes
Assessment against linked issues
Poem
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. 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 using PR comments)
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: 1
🧹 Nitpick comments (3)
datatypes.md (3)
118-124: Promote “Purpose” to a sub-heading and wrap ISO-8601 literals in back-ticks.
- Making “Purpose” a fourth-level heading (
####) keeps the document outline consistent with the other section structures (Interactions, etc.).- Wrapping
YYYY-MM-DDin back-ticks prevents spell-checker noise and improves readability.- “birth dates” → “birthdates” fixes the LanguageTool warning.
-### Date - -Represents a calendar date in the format YYYY-MM-DD. - -Purpose -Use Date to store and compare dates without time information, e.g. birth dates, due dates, or deadlines. +### Date + +Represents a calendar date in the format `YYYY-MM-DD`. + +#### Purpose +Use Date to store and compare dates without time information, e.g. birthdates, due dates, or deadlines.Please apply the same pattern to the Time, DateTime, and Duration sections for uniformity.
141-147: Apply the same structural & formatting adjustments here.Convert the plain “Purpose” line to a level-4 heading and wrap the
hh:mm:ssexample in back-ticks:-Represents a time of day, in the format hh:mm:ss. +Represents a time of day, in the format `hh:mm:ss`. -Purpose +#### Purpose Use Time to store specific times (e.g. store hours, alarm times) without date context.Replicate this change for the DateTime and Duration sections to keep the documentation consistent.
169-176: Tighten wording and format literals to silence style & spell checks.
- “point in time” is sufficient; remove “combining both date and time” (redundant).
- Wrap the
YYYY-MM-DDTHH:MM:SSliteral in back-ticks.- Prepend
#### Purposeheading.-Represents a point in time, combining both date and time. Format: YYYY-MM-DDTHH:MM:SS. +Represents a point in time. Format: `YYYY-MM-DDTHH:MM:SS`.These tweaks align with earlier suggestions and clear the MOMENT_IN_TIME style warning.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
datatypes.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
datatypes.md
[misspelling] ~123-~123: This word is normally spelled as one.
Context: ...re dates without time information, e.g. birth dates, due dates, or deadlines. ```cypher CR...
(EN_COMPOUNDS_BIRTH_DATES)
[style] ~169-~169: This phrase is redundant. Consider writing “point” or “time”.
Context: ... // 20 ``` ### DateTime Represents a point in time, combining both date and time. Format: ...
(MOMENT_IN_TIME)
🪛 markdownlint-cli2 (0.17.2)
datatypes.md
108-108: Link fragments should be valid
Expected: #date; Actual: #Date
(MD051, link-fragments)
110-110: Link fragments should be valid
Expected: #time; Actual: #Time
(MD051, link-fragments)
112-112: Link fragments should be valid
Expected: #datetime; Actual: #DateTime
(MD051, link-fragments)
114-114: Link fragments should be valid
Expected: #duration; Actual: #Duration
(MD051, link-fragments)
🪛 GitHub Actions: spellcheck
datatypes.md
[error] 1-1: Spelling errors detected: 'YYYY', 'hh', 'ss', 'DDTHH', 'localdatetime', 'DT', 'datetimes', 'durations'.
| ## 1. [Date](#Date) | ||
|
|
||
| ## 2. [Time](#Time) | ||
|
|
||
| ## 3. [DateTime](#DateTime) | ||
|
|
||
| ## 4. [Duration](#Duration) | ||
|
|
There was a problem hiding this comment.
Fix invalid internal anchor links to satisfy markdownlint (MD051).
The link fragments are capitalized (#Date, #Time, …) while the autogenerated IDs for the headings are lowercase (#date, #time, …).
This breaks in-page navigation and causes the lint failure reported in the pipeline.
-## 1. [Date](#Date)
-## 2. [Time](#Time)
-## 3. [DateTime](#DateTime)
-## 4. [Duration](#Duration)
+## 1. [Date](#date)
+## 2. [Time](#time)
+## 3. [DateTime](#datetime)
+## 4. [Duration](#duration)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 1. [Date](#Date) | |
| ## 2. [Time](#Time) | |
| ## 3. [DateTime](#DateTime) | |
| ## 4. [Duration](#Duration) | |
| ## 1. [Date](#date) | |
| ## 2. [Time](#time) | |
| ## 3. [DateTime](#datetime) | |
| ## 4. [Duration](#duration) |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
108-108: Link fragments should be valid
Expected: #date; Actual: #Date
(MD051, link-fragments)
110-110: Link fragments should be valid
Expected: #time; Actual: #Time
(MD051, link-fragments)
112-112: Link fragments should be valid
Expected: #datetime; Actual: #DateTime
(MD051, link-fragments)
114-114: Link fragments should be valid
Expected: #duration; Actual: #Duration
(MD051, link-fragments)
🤖 Prompt for AI Agents
In datatypes.md around lines 108 to 115, the internal anchor links use
capitalized fragments like #Date and #Time, but the actual heading IDs are
lowercase. Update all anchor links to use lowercase fragments (#date, #time,
etc.) to match the autogenerated heading IDs and fix the markdownlint MD051
error.
Resolves: #166
Summary by CodeRabbit