Skip to content
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

Merged
merged 1 commit into from
Mar 10, 2024
Merged

Fixed the table markers #29

merged 1 commit into from
Mar 10, 2024

Conversation

gkorland
Copy link
Contributor

@gkorland gkorland commented Mar 10, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the configuration parameters table to clarify which settings can be adjusted at load-time versus run-time.

@gkorland gkorland requested a review from swilly22 March 10, 2024 07:17
Copy link
Contributor

coderabbitai bot commented Mar 10, 2024

Walkthrough

The 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

Files Change Summary
configuration.md Updated symbols for load-time vs. run-time parameters

🐇✨
In the land of code and byte,
A change was made, oh so slight.
Symbols shifted, clarity in sight,
Configuring with newfound delight.
Hop along, on this journey bright!
🌟📄

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between ea1562f and 4b45a14.
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.

Comment on lines 65 to 85

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 |

---

Copy link
Contributor

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.

@swilly22 swilly22 merged commit a94060e into main Mar 10, 2024
1 check passed
@swilly22 swilly22 deleted the gkorland-table-fix branch March 10, 2024 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants