Docs: date UDF updates + OGM client libraries section#378
Open
shahar-biron wants to merge 7 commits intomainfrom
Open
Docs: date UDF updates + OGM client libraries section#378shahar-biron wants to merge 7 commits intomainfrom
shahar-biron wants to merge 7 commits intomainfrom
Conversation
- Add new section for Official ORM libraries below Official Clients - Include falkordb-py-orm (Python) - Include falkordb-go-orm (Go) - Include spring-data-falkordb (Java) - Add reference links for all ORM libraries Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Warp <agent@warp.dev>
Update terminology from Object-Relational Mapping (ORM) to Object-Graph Mapping (OGM) which is the correct term for graph databases. ORM refers to mapping objects to relational database tables, while OGM maps objects to graph structures (nodes and edges). - Update section heading and description - Keep all link references intact (falkordb-py-orm, falkordb-go-orm) - Add OGM and ogm to wordlist for spellcheck Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Warp <agent@warp.dev>
Contributor
📝 WalkthroughWalkthroughThis pull request expands documentation across three areas: removes an entry from the wordlist, adds comprehensive UI documentation for the FalkorDB Browser interface, and updates date UDF documentation with improved formatting and a new units table. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
browser/ui/table-view.md (1)
12-14: Avoid internal API naming in user docs.
“graph.Data” reads like an internal type; consider phrasing as “non‑empty tabular results” only.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@browser/ui/table-view.md` around lines 12 - 14, Replace the internal API type name "graph.Data" in the sentence describing when the Table tab is enabled with a user-friendly phrase such as "non‑empty tabular results"; locate the occurrence of the symbol "graph.Data" in the Table tab description and update the copy to remove the internal type reference and use plain wording (e.g., "when the current query produced non‑empty tabular results").
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@browser/ui/navigation.md`:
- Around line 12-13: Update the UI copy under the "Main navigation buttons"
section to use "username" as a single word instead of "user name" in the phrase
"user name/version block" so it reads "username/version block"; ensure any other
occurrences in this document follow the same "username" spelling.
---
Nitpick comments:
In `@browser/ui/table-view.md`:
- Around line 12-14: Replace the internal API type name "graph.Data" in the
sentence describing when the Table tab is enabled with a user-friendly phrase
such as "non‑empty tabular results"; locate the occurrence of the symbol
"graph.Data" in the Table tab description and update the copy to remove the
internal type reference and use plain wording (e.g., "when the current query
produced non‑empty tabular results").
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (19)
.wordlist.txtbrowser/index.mdbrowser/ui/chat-panel.mdbrowser/ui/data-panel.mdbrowser/ui/graph-canvas.mdbrowser/ui/graph-info-panel.mdbrowser/ui/graph-page.mdbrowser/ui/index.mdbrowser/ui/login.mdbrowser/ui/metadata-view.mdbrowser/ui/navigation.mdbrowser/ui/query-editor.mdbrowser/ui/query-history.mdbrowser/ui/settings.mdbrowser/ui/style-panel.mdbrowser/ui/table-view.mdbrowser/ui/toolbar-actions.mdudfs/flex/date/format.mdudfs/flex/date/truncate.md
💤 Files with no reviewable changes (1)
- .wordlist.txt
browser/ui/navigation.md
Outdated
Comment on lines
+12
to
+13
| ## Main navigation buttons | ||
| Located in the sidebar under the user name/version block: |
Contributor
There was a problem hiding this comment.
Consider “username” as one word.
“user name” is typically written as “username” in UI docs.
🧰 Tools
🪛 LanguageTool
[style] ~13-~13: It’s more common nowadays to write this noun as one word.
Context: ...uttons Located in the sidebar under the user name/version block: - SETTINGS → opens `...
(RECOMMENDED_COMPOUNDS)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@browser/ui/navigation.md` around lines 12 - 13, Update the UI copy under the
"Main navigation buttons" section to use "username" as a single word instead of
"user name" in the phrase "user name/version block" so it reads
"username/version block"; ensure any other occurrences in this document follow
the same "username" spelling.
shahar-biron
force-pushed
the
udfs-date-md-updates
branch
from
20cd3fc to
e8f0277
Compare
shahar-biron
changed the title
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
2 participants
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.
This PR now contains the non-browser documentation updates (split out from the browser UI docs).
Changes:
Browser UI documentation is now in PR #379 (standalone branch).