Update Docs towards New Version Deploy #155
Conversation
…ncdancy in match.md. fixed links
WalkthroughSeveral new documentation files were added covering graph algorithms (BFS, PageRank, SPpaths, SSpaths, WCC, Betweenness Centrality, CDLP), a general algorithms index, and the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FalkorDB
participant AlgorithmsModule
User->>FalkorDB: CALL algo.bfs(start_node, max_depth, relationship)
FalkorDB->>AlgorithmsModule: Execute BFS algorithm
AlgorithmsModule-->>FalkorDB: Return nodes, edges
FalkorDB-->>User: Output results
User->>FalkorDB: CALL algo.pagerank([label], [relationship])
FalkorDB->>AlgorithmsModule: Execute PageRank
AlgorithmsModule-->>FalkorDB: Return node, score
FalkorDB-->>User: Output results
User->>FalkorDB: CALL algo.SPpaths(source, target, ...)
FalkorDB->>AlgorithmsModule: Execute SPpaths
AlgorithmsModule-->>FalkorDB: Return path, pathWeight, pathCost
FalkorDB-->>User: Output results
User->>FalkorDB: CALL algo.SSpaths(source, ...)
FalkorDB->>AlgorithmsModule: Execute SSpaths
AlgorithmsModule-->>FalkorDB: Return path, pathWeight, pathCost
FalkorDB-->>User: Output results
User->>FalkorDB: CALL algo.wcc([config])
FalkorDB->>AlgorithmsModule: Execute WCC
AlgorithmsModule-->>FalkorDB: Return node, componentId
FalkorDB-->>User: Output results
User->>FalkorDB: CALL algo.betweenness([nodeLabels], [relationshipTypes])
FalkorDB->>AlgorithmsModule: Execute Betweenness Centrality
AlgorithmsModule-->>FalkorDB: Return node, score
FalkorDB-->>User: Output results
User->>FalkorDB: CALL algo.labelPropagation([config])
FalkorDB->>AlgorithmsModule: Execute CDLP
AlgorithmsModule-->>FalkorDB: Return node, communityId
FalkorDB-->>User: Output results
User->>FalkorDB: GRAPH.MEMORY USAGE <graph-name> [SAMPLES <count>]
FalkorDB-->>User: Return memory usage statistics
Suggested labels
Suggested reviewers
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: 8
🧹 Nitpick comments (16)
configuration.md (1)
397-416: Clarify load-time-only behaviorExplicitly note in the
DEDUPLICATE_STRINGSsection that this parameter is load-time-only and cannot be modified at run-time viaGRAPH.CONFIG SET. Consider adding:“This parameter is load-time-only; attempting to set it at run-time will result in an error.”
🧰 Tools
🪛 LanguageTool
[uncategorized] ~409-~409: Loose punctuation mark.
Context: ...GSisno. #### Valid values -yes`: Enables string interning (deduplication...(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
415-415: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
commands/graph.mamory-usage.md (3)
12-16: Enhance usage example clarityShow a sample output to illustrate the format of the returned array. For example:
GRAPH.MEMORY USAGE myGraph # => [50.2, 10.0, 5.1, 20.6, 14.5, 0.0]This helps users map output values to the fields listed.
25-37: Document field order explicitlyAdd a note that the returned array values are ordered as listed in the table (total_graph_sz_mb, label_matrices_sz_mb, etc.), so users know which index corresponds to which metric.
50-54: Specify default sample countIn the Notes section, state the default
SAMPLESvalue used when the argument is omitted (e.g., 100) so users have precise expectations about the sampling behavior.algorithms/pagerank.md (2)
1-4: Add navigation metadataInclude
nav_order(and optionallyparent: "Algorithms") in the YAML front-matter to integrate this document under the Algorithms section:--- title: "PageRank" nav_order: 2 parent: "Algorithms" ---🧰 Tools
🪛 GitHub Actions: spellcheck
[error] 1-1: Spelling errors detected: 'Brin', 'Sergey'.
95-97: Fix list indentation under Usage NotesResolve the MD007 warning by using 2-space indentation for list items under Interpreting scores:
- - PageRank scores are relative, not absolute measures - - The sum of all scores in a graph equals 1.0 - - Scores typically follow a power-law distribution + - PageRank scores are relative, not absolute measures + - The sum of all scores in a graph equals 1.0 + - Scores typically follow a power-law distribution🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
95-95: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
96-96: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
97-97: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
cypher/functions.md (2)
201-208: Correct table formatting for Path functionsEnsure the new Path functions table has leading and trailing pipes and aligned separators. Add a trailing pipe on the
allShortestPathsrow and align the header:| Function | Description | |--------------------------------------------|--------------------------------------------------------------| - | [allShortestPaths(...)](#about-path-functions) * | Returns all the shortest paths between a pair of entities + | [allShortestPaths(...)](#about-path-functions) * | Returns all the shortest paths between a pair of entities |🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
207-207: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
328-335: Refine wording in About Path FunctionsReduce wordiness and improve clarity in the
shortestPathdescription. For example:- `shortestPath` returns one of the shortest paths. If there is more than one, only one is retrieved. + The `shortestPath` function returns a single shortest path; if multiple exist, it returns one arbitrarily.algorithms/wcc.md (2)
53-53: Remove trailing punctuation from heading
Change the "Examples" heading to comply with markdownlint MD026:-## Examples: +## Examples
40-44: Ensure blank lines around parameters table
Add a blank line before and after the table to satisfy markdownlint MD058:The procedure accepts an optional configuration `Map` with the following parameters: + | Name | Type | Default | Description | |---------------------|-------|------------------------|----------------------------------------------------------------------------------| | `nodeLabels` | Array | All labels | Array of node labels to filter which nodes are included in the computation | | `relationshipTypes` | Array | All relationship types | Array of relationship types to define which edges are traversed | +algorithms/sppath.md (3)
52-52: Remove trailing punctuation from Examples heading
Update the heading to remove the colon as per markdownlint MD026:-## Examples: +## Examples🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...oss the path (if used) | ## Examples: Lets take this Road Network Grpah as an exam...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
🪛 markdownlint-cli2 (0.17.2)
52-52: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
57-57: Remove trailing colon from subheading
Modify the subheading to remove the trailing colon:-### Example: Shortest Path by Distance from City A to City G: +### Example: Shortest Path by Distance from City A to City G🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
57-57: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
69-75: Add blank lines around result table
Insert blank lines before and after the table to satisfy markdownlint MD058:CALL algo.SPpaths({ sourceNode: a, targetNode: g, relTypes: ['Road'], weightProp: 'dist' }) YIELD path, pathWeight RETURN pathWeight, [n in nodes(path) | n.name] AS pathNodes + | pathWeight | pathNodes | |------------|---------------| | `12` | [A, D, E G] | +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
71-71: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
72-72: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
algorithms/bfs.md (1)
16-19: Specify Cypher syntax highlighting
Use a language specifier on the code fence for consistency and readability:-``` +```cypher CALL algo.bfs(start_node, max_depth, relationship) YIELD nodes, edges</blockquote></details> <details> <summary>algorithms/sspath.md (2)</summary><blockquote> `31-31`: **Remove trailing punctuation from heading** Update to comply with markdownlint MD026: ```diff -## Examples: +## Examples🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...targetNodeis omitted. ## Examples: Lets take this Road Network Grpah as an exam...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
53-63: Ensure blank lines around expected-result tables
Add blank lines before and after the tables to satisfy markdownlint MD058:### Example: All Shortest Paths by Distance (up to 10 km) MATCH (a:City{name:'A'}) CALL algo.SSpaths({ sourceNode: a, relTypes: ['Road'], costProp: 'dist', maxCost: 10, pathCount: 1000 }) YIELD path, pathCost RETURN pathCost, [n in nodes(path) | n.name] AS pathNodes ORDER BY pathCost + | pathCost | pathNodes | |----------| ---------- | | `2` | [A, D] | | `3` | [A, B] | | `6` | [A, D, C] | | `7` | [A, D, E] | | `8` | [A, C] | | `10` | [A, B, E] | + ### Example: Top 5 Shortest Paths from A by Distance ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (3)
images/graph_bfs.pngis excluded by!**/*.pngimages/graph_page_rank.pngis excluded by!**/*.pngimages/wcc.pngis excluded by!**/*.png
📒 Files selected for processing (12)
algorithms/bfs.md(1 hunks)algorithms/index.md(1 hunks)algorithms/pagerank.md(1 hunks)algorithms/sppath.md(1 hunks)algorithms/sspath.md(1 hunks)algorithms/wcc.md(1 hunks)commands/graph.mamory-usage.md(1 hunks)configuration.md(2 hunks)cypher/algorithms.md(0 hunks)cypher/functions.md(2 hunks)cypher/match.md(0 hunks)path_algorithm.md(0 hunks)
💤 Files with no reviewable changes (3)
- cypher/algorithms.md
- cypher/match.md
- path_algorithm.md
🧰 Additional context used
🪛 LanguageTool
configuration.md
[uncategorized] ~409-~409: Loose punctuation mark.
Context: ...GSisno. #### Valid values - yes`: Enables string interning (deduplication...
(UNLIKELY_OPENING_PUNCTUATION)
cypher/functions.md
[uncategorized] ~339-~339: Possible missing preposition found.
Context: ...## shortestPath shortestPath returns one of the shortest paths. If there is more...
(AI_EN_LECTOR_MISSING_PREPOSITION)
[style] ~341-~341: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...is pattern's endpoints must be resolved prior to the function call, and no property filt...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~341-~341: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... will be included in the returned path. If no shortest path can be found, NULL is ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
algorithms/sppath.md
[uncategorized] ~52-~52: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...oss the path (if used) | ## Examples: Lets take this Road Network Grpah as an exam...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
algorithms/sspath.md
[uncategorized] ~31-~31: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... targetNode is omitted. ## Examples: Lets take this Road Network Grpah as an exam...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
🪛 markdownlint-cli2 (0.17.2)
configuration.md
415-415: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
cypher/functions.md
207-207: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
algorithms/sppath.md
52-52: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
57-57: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
71-71: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
72-72: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
77-77: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
94-94: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
95-95: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
algorithms/pagerank.md
95-95: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
96-96: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
97-97: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
🪛 GitHub Actions: spellcheck
configuration.md
[error] 1-1: Spelling errors detected: 'DEDUPLICATE', 'deduplicates', 'deduplication', '' tags present.
algorithms/index.md
[error] 1-1: Spelling errors detected: 'analytics', 'Pathfinding', 'SPPATH', 'SSPATH', 'WCC'.
algorithms/wcc.md
[error] 1-1: Multiple spelling errors detected: 'WCC', 'undirected', 'preprocessing', 'subgraphs', 'directionality', 'iteratively', 'Grpah'.
algorithms/sppath.md
[error] 1-1: Spelling error detected: 'Grpah'.
algorithms/pagerank.md
[error] 1-1: Spelling errors detected: 'Brin', 'Sergey'.
algorithms/sspath.md
[error] 1-1: Spelling error detected: 'Grpah'.
🔇 Additional comments (1)
configuration.md (1)
88-88: Validate anchor link consistencyEnsure that the table entry
[DEDUPLICATE_STRINGS](#deduplicate_strings)correctly matches the section heading’s generated anchor (deduplicate_strings). Verify that clicking this link navigates to the new section as expected.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
algorithms/sspath.md (2)
29-29: Fix cross-reference link
The link currently points to./sspath.md#syntaxbut should reference the SPpaths documentation insppath.md#syntax.
32-32: Correct grammar in example introduction
Add the missing apostrophe in "Lets" to become "Let's".algorithms/wcc.md (1)
55-55: Correct example introduction grammar
Add the missing apostrophe in "Lets" to become "Let's".
🧹 Nitpick comments (1)
algorithms/wcc.md (1)
57-57: Improve alt text for accessibility
The alt text "Graph BFS" does not match this WCC example. Consider updating it to something like"Weakly Connected Components graph".
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (5)
algorithms/index.md(1 hunks)algorithms/sppath.md(1 hunks)algorithms/sspath.md(1 hunks)algorithms/wcc.md(1 hunks)commands/graph.memory-usage.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- commands/graph.memory-usage.md
🚧 Files skipped from review as they are similar to previous changes (2)
- algorithms/sppath.md
- algorithms/index.md
🧰 Additional context used
🪛 LanguageTool
algorithms/wcc.md
[uncategorized] ~54-~54: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... the node belongs to | ## Examples Lets take this Social Graph as an example: ...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
🪛 GitHub Actions: spellcheck
algorithms/wcc.md
[error] 1-1: Spelling errors detected: 'WCC', 'undirected', 'preprocessing', 'subgraphs', 'directionality', 'iteratively'.
🔇 Additional comments (1)
algorithms/wcc.md (1)
33-33: Verify procedure name casing
The syntax showsCALL algo.wcc([config]), but algorithm procedure names are typically uppercase (e.g.,CALL algo.WCC(...)). Please confirm the correct casing and update accordingly.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
algorithms/wcc.md (1)
56-56: Fix missing apostrophe in example caption.
Change “Lets” to “Let's” to correct the contraction.-Lets take this Social Graph as an example: +Let's take this Social Graph as an example:algorithms/sppath.md (1)
55-55: Fix missing apostrophe in example introduction.
Change “Lets” to “Let's” to correct the contraction.-Lets take this Road Network Graph as an example: +Let's take this Road Network Graph as an example:algorithms/sspath.md (2)
32-32: Fix missing apostrophe in example introduction.
Change “Lets” to “Let's” to correct the contraction.-Lets take this Road Network Graph as an example: +Let's take this Road Network Graph as an example:
29-29:⚠️ Potential issueFix cross-reference link.
The link incorrectly points tosspath.md; it should referencesppath.mdfor the SPpaths syntax.-Same as [`algo.SPpaths`](./sspath.md), except `targetNode` is omitted. +Same as [`algo.SPpaths`](./sppath.md), except `targetNode` is omitted.
🧹 Nitpick comments (8)
algorithms/pagerank.md (2)
95-97: Fix list indentation in Usage Notes.
Unordered list items should not be indented; remove leading spaces for consistency.- - PageRank scores are relative, not absolute measures - - The sum of all scores in a graph equals 1.0 - - Scores typically follow a power-law distribution + - PageRank scores are relative, not absolute measures + - The sum of all scores in a graph equals 1.0 + - Scores typically follow a power-law distribution🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
97-97: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
72-72: Enhance image alt text.
Use clearer, more descriptive alt text for the PageRank example image for accessibility.- +algorithms/sppath.md (3)
54-54: Remove trailing punctuation in heading.
The “## Examples:” heading should not end with a colon.-## Examples: +## Examples🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
54-54: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
59-59: Remove trailing punctuation in subheading.
The “### Example: Shortest Path by Distance from City A to City G:” heading should not end with a colon.-### Example: Shortest Path by Distance from City A to City G: +### Example: Shortest Path by Distance from City A to City G🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
59-59: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
74-74: Surround tables with blank lines.
Add a blank line before and after the result table for better readability.+ | pathWeight | pathNodes | |------------|---------------| | `12` | [A, D, E G] | +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
algorithms/sspath.md (3)
31-31: Remove trailing punctuation in heading.
The “## Examples:” heading should not end with a colon.-## Examples: +## Examples🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...targetNodeis omitted. ## Examples: Lets take this Road Network Graph as an exam...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
🪛 markdownlint-cli2 (0.17.2)
31-31: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
53-53: Remove trailing punctuation in subheading.
The “#### Expected Result:” heading should not end with a colon.-#### Expected Result: +#### Expected Result🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
53-53: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
81-81: Remove trailing punctuation in subheading.
The “#### Expected Result:” heading should not end with a colon.-#### Expected Result: +#### Expected Result🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
81-81: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (6)
algorithms/bfs.md(1 hunks)algorithms/index.md(1 hunks)algorithms/pagerank.md(1 hunks)algorithms/sppath.md(1 hunks)algorithms/sspath.md(1 hunks)algorithms/wcc.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- algorithms/bfs.md
- algorithms/index.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
algorithms/sppath.md
54-54: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
59-59: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
73-73: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
74-74: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
79-79: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
96-96: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
97-97: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
algorithms/pagerank.md
97-97: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
98-98: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
99-99: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
algorithms/sspath.md
31-31: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
53-53: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
54-54: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
81-81: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
82-82: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
🪛 LanguageTool
algorithms/sspath.md
[uncategorized] ~31-~31: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... targetNode is omitted. ## Examples: Lets take this Road Network Graph as an exam...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
algorithms/wcc.md
[uncategorized] ~55-~55: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... the node belongs to | ## Examples Lets take this Social Graph as an example: ...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
cypher/indexing.md (1)
221-233: Enhancement: include a string-array example and note multi-valued index behavior.
To showcase that array indexing works for strings as well, consider adding an example like:+```sh +# Create a node with a string-array property +GRAPH.QUERY DEMO_GRAPH "CREATE (:Item {tags: ['red', 'blue', 'green']})" + +# Use the array index to find nodes containing 'blue' +GRAPH.QUERY DEMO_GRAPH "MATCH (i:Item) WHERE 'blue' IN i.tags RETURN i" +```Additionally, you could mention that this index behaves as a multi-valued index, indexing each element separately under the hood.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
cypher/indexing.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: spellcheck
cypher/indexing.md
[error] 1-1: Spelling check failed: Misspelled word '' found in the file.
🔇 Additional comments (1)
cypher/indexing.md (1)
215-219: New Array Indices section is clear and accurate.
The heading and description correctly explain that FalkorDB supports indexing scalar arrays and explicitly call out unsupported types. This aligns well with the existing indexing documentation.
…pdate new memory usage (4) minor edits and fixes
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (7)
algorithms/index.md (1)
2-5: Consistent metadata title
The YAML front-mattertitle: "Algorithms"differs from the page heading "FalkorDB Algorithms Overview". Consider renaming it to"Algorithms Overview"to ensure consistency in navigation and display.algorithms/betweenness_centrality.md (1)
89-91: Clarify sentence structure for consistency
The bullet pointCan be computationally expensive on large, dense graphs.lacks a clear subject. Consider rephrasing:- - Can be computationally expensive on large, dense graphs. + - The algorithm can be computationally expensive on large, dense graphs.🧰 Tools
🪛 LanguageTool
[style] ~91-~91: To form a complete sentence, be sure to include a subject.
Context: ...etween clusters tend to score higher. - Can be computationally expensive on large, ...(MISSING_IT_THERE)
algorithms/sppath.md (1)
55-55: Fix grammatical typo
Change the example introduction to include the missing apostrophe:- Lets take this Road Network Graph as an example: + Let's take this Road Network Graph as an example:algorithms/wcc.md (3)
56-56: Fix grammatical typo
Include the missing apostrophe in the example caption:- Lets take this Social Graph as an example: + Let's take this Social Graph as an example:
55-55: Remove trailing punctuation in heading
The heading## Examples:should not include a trailing colon. Change it to:- ## Examples: + ## Examples
58-58: Improve image alt text for clarity
Enhance accessibility by using a more descriptive alt text. For example:-  + algorithms/sspath.md (1)
51-51: Fix grammatical typo
Add the missing apostrophe in the example introduction:- Lets take this Road Network Graph as an example: + Let's take this Road Network Graph as an example:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
images/between.pngis excluded by!**/*.pngimages/graph_query_road.pngis excluded by!**/*.pngimages/road_network.pngis excluded by!**/*.png
📒 Files selected for processing (10)
.wordlist.txt(1 hunks)algorithms/betweenness_centrality.md(1 hunks)algorithms/bfs.md(1 hunks)algorithms/index.md(1 hunks)algorithms/sppath.md(1 hunks)algorithms/sspath.md(1 hunks)algorithms/wcc.md(1 hunks)commands/graph.memory-usage.md(1 hunks)configuration.md(1 hunks)cypher/indexing.md(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- configuration.md
🚧 Files skipped from review as they are similar to previous changes (4)
- .wordlist.txt
- cypher/indexing.md
- algorithms/bfs.md
- commands/graph.memory-usage.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
algorithms/wcc.md
54-54: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
91-91: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
106-106: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
110-110: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
111-111: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
algorithms/betweenness_centrality.md
[style] ~91-~91: To form a complete sentence, be sure to include a subject.
Context: ...etween clusters tend to score higher. - Can be computationally expensive on large, ...
(MISSING_IT_THERE)
algorithms/sppath.md
[uncategorized] ~54-~54: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ss the path (if used) | ## Examples: Lets take this Road Network Graph as an exam...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
algorithms/sspath.md
[uncategorized] ~50-~50: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ss the path (if used) | ## Examples: Lets take this Road Network Graph as an exam...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
| - **[SPpath](./sppath.md)** | ||
| Computes the shortest paths between a source and one or more destination nodes. | ||
|
|
||
| - **[SSpath](./sspath.md)** | ||
| Enumerates all paths from a single source node to other nodes, based on constraints like edge filters and depth. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Align algorithm link text with procedure names
The display names SPpath and SSpath should match the actual procedures algo.SPpaths() and algo.SSpaths(). Update them as follows:
- - **[SPpath](./sppath.md)**
+ - **[SPpaths](./sppath.md)**
- - **[SSpath](./sspath.md)**
+ - **[SSpaths](./sspath.md)**📝 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.
| - **[SPpath](./sppath.md)** | |
| Computes the shortest paths between a source and one or more destination nodes. | |
| - **[SSpath](./sspath.md)** | |
| Enumerates all paths from a single source node to other nodes, based on constraints like edge filters and depth. | |
| - **[SPpaths](./sppath.md)** | |
| Computes the shortest paths between a source and one or more destination nodes. | |
| - **[SSpaths](./sspath.md)** | |
| Enumerates all paths from a single source node to other nodes, based on constraints like edge filters and depth. |
🤖 Prompt for AI Agents
In algorithms/index.md around lines 28 to 33, the displayed algorithm names
SPpath and SSpath do not match the actual procedure names algo.SPpaths() and
algo.SSpaths(). Update the link text to exactly match the procedure names by
changing SPpath to SPpaths and SSpath to SSpaths to ensure consistency and
clarity.
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
.wordlist.txt (1)
364-381: 💡 Verification agent❓ Verification inconclusive
Missing entries for DEDUPLICATE_STRINGS and GRAPH.QUERY
The documentation added for theDEDUPLICATE_STRINGSfeature and theGRAPH.QUERYcommand isn’t reflected here. Please include these exact terms to ensure consistency with your new docs:DEDUPLICATE_STRINGS GRAPH.QUERY
Add missing entries to .wordlist.txt
Please include the two new terms so the word list stays in sync with your docs:
• File:
.wordlist.txt(around lines 364–381)
• Insert the exact entries:.wordlist.txt (around line 380) +DEDUPLICATE_STRINGS +GRAPH.QUERY🧰 Tools
🪛 LanguageTool
[uncategorized] ~378-~378: Ger doublet «Betweenness betweenness».
Context: ...finding Brin Sergey lookups componentId Betweenness betweenness(GER_DOUBLET)
🧹 Nitpick comments (2)
.wordlist.txt (2)
379-380: Remove duplicate “Betweenness”/“betweenness” entry
The terms “Betweenness” and “betweenness” appear consecutively, which may cause duplication in your glossary. If your wordlist is case-insensitive, consolidate them into one entry. If it’s case-sensitive, please confirm whether both variants are actually required.
364-381: Maintain alphabetical ordering of entries
The file is generally sorted alphabetically, but these new algorithm terms have been appended at the end. For better readability and maintainability, please insertWCC,SPpath,SSpath, and the other new entries into their proper alphabetic locations—keeping uppercase terms grouped separately from lowercase ones.🧰 Tools
🪛 LanguageTool
[uncategorized] ~378-~378: Ger doublet «Betweenness betweenness».
Context: ...finding Brin Sergey lookups componentId Betweenness betweenness(GER_DOUBLET)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.wordlist.txt(1 hunks)commands/graph.memory-usage.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- commands/graph.memory-usage.md
🧰 Additional context used
🪛 LanguageTool
.wordlist.txt
[uncategorized] ~378-~378: Ger doublet «Betweenness betweenness».
Context: ...finding Brin Sergey lookups componentId Betweenness betweenness
(GER_DOUBLET)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
algorithms/cdlp.md (5)
42-44: Include YIELD clause in the Syntax section. To match the examples below and clarify which fields are returned, expand the syntax to include theYIELD node, communityIdclause.-```cypher -CALL algo.labelPropagation([config]) -``` +```cypher +CALL algo.labelPropagation([config]) YIELD node, communityId +```
68-74: Specify code fence language for ASCII graph example. Linters (MD040) expect a language identifier on fenced code blocks. Update the opening fence, for example:-``` +```plaintext (Alice)---(Bob)---(Charlie) (Kate) | | | (Diana) | (Eve)---(Frank) | | | | (Grace)--(Henry) (Iris)--(Jack) -``` +```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
68-68: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
116-117: Surround the first results table with blank lines. Per MD058, tables must be preceded by a blank line. Insert an empty line after the heading:-#### Expected Results -| name | communityId | +#### Expected Results + +| name | communityId |🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
117-117: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
167-168: Surround the second results table with blank lines. Add a blank line after the heading to comply with MD058:-#### Expected Results -| community_members | communityId | community_size | +#### Expected Results + +| community_members | communityId | community_size |🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
167-167: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
1-3: Add domain-specific terms to the spellchecker dictionary. To eliminate spellcheck failures forCDLPandcommunityId, include them in the repository's spelling exceptions (e.g.,.spellingor equivalent).🧰 Tools
🪛 GitHub Actions: spellcheck
[error] 1-1: Spelling errors detected: 'CDLP' repeated multiple times.
[error] 1-1: Spelling errors detected: 'communityId' repeated multiple times.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
algorithms/cdlp.md(1 hunks)algorithms/index.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- algorithms/index.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
algorithms/cdlp.md
68-68: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
117-117: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
167-167: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
🪛 GitHub Actions: spellcheck
algorithms/cdlp.md
[error] 1-1: Spelling errors detected: 'CDLP' repeated multiple times.
[error] 1-1: Spelling errors detected: 'communityId' repeated multiple times.
🔇 Additional comments (1)
algorithms/cdlp.md (1)
1-5: Front matter and header are well-structured. The YAML front matter (title,description,parent) aligns with existing algorithm docs, and the primary heading accurately reflects the content.🧰 Tools
🪛 GitHub Actions: spellcheck
[error] 1-1: Spelling errors detected: 'CDLP' repeated multiple times.
[error] 1-1: Spelling errors detected: 'communityId' repeated multiple times.
swilly22
force-pushed
the
add-algo-section
branch
from
c8668e4 to
dea9e92
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.wordlist.txt (2)
365-367: Verify algorithm naming and placement
The entriesWCC,SPpath, andSSpathare correctly added but:
- The wordlist is alphabetized;
SPpath/SSpathshould be grouped with the existing S-prefixed entries (e.g.,SPpaths/SSpaths).- Confirm whether the commands are singular (
SPpath/SSpath) or plural per the documentation.
369-381: Enforce alphabetical order & remove duplicate
This block breaks the established alphabetical ordering and contains a duplicate pair (Betweennessvsbetweenness). Please:
- Reorder entries alphabetically.
- Normalize or remove the duplicate casing on “Betweenness.”
🧰 Tools
🪛 LanguageTool
[uncategorized] ~380-~380: Ger doublet «Betweenness betweenness».
Context: ...finding Brin Sergey lookups componentId Betweenness betweenness(GER_DOUBLET)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.wordlist.txt(2 hunks)algorithms/index.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- algorithms/index.md
🧰 Additional context used
🪛 LanguageTool
.wordlist.txt
[uncategorized] ~380-~380: Ger doublet «Betweenness betweenness».
Context: ...finding Brin Sergey lookups componentId Betweenness betweenness
(GER_DOUBLET)
🔇 Additional comments (2)
.wordlist.txt (2)
16-17: Approve new entries: CDLP and communityId
These terms align with the newly documented Community Detection Label Propagation feature and its parameter naming.
114-114: Approve new entry: allShortestPaths
This matches the documented function/API name for enumerating all shortest paths.
Summary by CodeRabbit
New Features
GRAPH.MEMORY USAGEcommand, detailing memory usage reporting for graphs.Documentation
allShortestPathsfunction.INoperator.