-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixed the table markers #29
Conversation
WalkthroughThe recent update primarily involves modifications to the documentation, particularly focusing on the clarity of configuration parameters. The distinction between load-time and run-time settings has been made more explicit through an update in the symbols used within the documentation. This change aims to enhance user understanding and navigation of configuration options. Changes
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (1)
- configuration.md (1 hunks)
Additional comments: 1
configuration.md (1)
- 68-82: The table has been updated to correct the symbols indicating load-time and run-time configuration parameters. Ensure that the symbols used ('V' for load-time and 'X' for run-time) are consistently applied and accurately reflect the configuration capabilities of each parameter.
|
||
The following table summarizes which configuration parameters can be set at module load-time and which can also be set at run-time: | ||
|
||
| Configuration Parameter | Load-time | Run-time | | ||
| :------- | :----- | :----------- | | ||
| [THREAD_COUNT](#thread_count) | :white_check_mark: | :white_large_square: | | ||
| [CACHE_SIZE](#cache_size) | :white_check_mark: | :white_large_square: | | ||
| [OMP_THREAD_COUNT](#omp_thread_count) | :white_check_mark: | :white_large_square: | | ||
| [NODE_CREATION_BUFFER](#node_creation_buffer) | :white_check_mark: | :white_large_square: | | ||
| [BOLT_PORT](#bolt_port) | :white_check_mark: | :white_large_square: | | ||
| [MAX_QUEUED_QUERIES](#max_queued_queries) | :white_check_mark: | :white_check_mark: | | ||
| [TIMEOUT](#timeout) (deprecated in RedisGraph v2.10) | :white_check_mark: | :white_check_mark: | | ||
| [TIMEOUT_MAX](#timeout_max) (since RedisGraph v2.10) | :white_check_mark: | :white_check_mark: | | ||
| [TIMEOUT_DEFAULT](#timeout_default) (since RedisGraph v2.10) | :white_check_mark: | :white_check_mark: | | ||
| [RESULTSET_SIZE](#resultset_size) | :white_check_mark: | :white_check_mark: | | ||
| [QUERY_MEM_CAPACITY](#query_mem_capacity) | :white_check_mark: | :white_check_mark: | | ||
| [VKEY_MAX_ENTITY_COUNT](#vkey_max_entity_count) | :white_check_mark: | :white_check_mark: | | ||
| [EFFECTS_THRESHOLD](#effects_threshold) | :white_check_mark: | :white_check_mark: | | ||
| Configuration Parameter | Load-time| Run-time| | ||
| :------- | :-----| :-----| | ||
| [THREAD_COUNT](#thread_count) | V | X | | ||
| [CACHE_SIZE](#cache_size) | V | X | | ||
| [OMP_THREAD_COUNT](#omp_thread_count) | V | X | | ||
| [NODE_CREATION_BUFFER](#node_creation_buffer) | V | X | | ||
| [BOLT_PORT](#bolt_port) | V | X | | ||
| [MAX_QUEUED_QUERIES](#max_queued_queries) | V | V | | ||
| [TIMEOUT](#timeout) (deprecated in RedisGraph v2.10) | V | V | | ||
| [TIMEOUT_MAX](#timeout_max) (since RedisGraph v2.10) | V | V | | ||
| [TIMEOUT_DEFAULT](#timeout_default) (since RedisGraph v2.10) | V | V | | ||
| [RESULTSET_SIZE](#resultset_size) | V | V | | ||
| [QUERY_MEM_CAPACITY](#query_mem_capacity) | V | V | | ||
| [VKEY_MAX_ENTITY_COUNT](#vkey_max_entity_count) | V | V | | ||
| [EFFECTS_THRESHOLD](#effects_threshold) | V | V | | ||
|
||
--- | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [11-11]
After the expression ‘for example’, a comma is usually used. Consider adding a comma for grammatical correctness.
- For example the following will run the server with global authentication password and 4 threads.
+ For example, the following will run the server with global authentication password and 4 threads.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [47-47]
The verb form seems incorrect. Consider changing "to allowing" to "to allow" for correct grammar.
- FalkorDB exposes the `GRAPH.CONFIG` command to allowing for the setting and retrieval of configuration parameters at run-time.
+ FalkorDB exposes the `GRAPH.CONFIG` command to allow for the setting and retrieval of configuration parameters at run-time.
Summary by CodeRabbit