Skip to content

Add note on node ID filtering in settings documentation#313

Merged
DTTerastar merged 1 commit intoESPresense:mainfrom
pjvander:patch-1
Apr 29, 2026
Merged

Add note on node ID filtering in settings documentation#313
DTTerastar merged 1 commit intoESPresense:mainfrom
pjvander:patch-1

Conversation

@pjvander
Copy link
Copy Markdown
Contributor

@pjvander pjvander commented Apr 26, 2026

Added a note about the importance of not filtering out node IDs for proper operation.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated configuration settings documentation with additional clarification regarding filtering options.

Added a note about the importance of not filtering out node IDs for proper operation.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 26, 2026

Walkthrough

Documentation was updated to add a clarifying note in the Filtering section of the settings configuration, stating that filtering out node IDs should be avoided due to dependencies on inter-node communication and potential impacts on optimizer and Companion calibration features.

Changes

Cohort / File(s) Summary
Documentation Update
src/content/docs/configuration/settings.md
Added NOTE bullet to the Filtering section clarifying that filtering out node IDs should be avoided, as inter-node communication is necessary for proper operation and can cause dependent features (optimizers and Companion calibration) to fail or break.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a note about node ID filtering to the settings documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
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.

🧹 Nitpick comments (1)
src/content/docs/configuration/settings.md (1)

37-37: Polish wording for clarity and consistency.

Line 37 communicates the right warning, but a small reword makes it clearer and more idiomatic.

✍️ Suggested wording
-*  **NOTE:**  Be certain to not filter out node IDs as inter-node communication is required for proper operation and can break items such as optimizers and Calibration in Companion.
+* **NOTE:** Do not filter out node IDs. Inter-node communication is required for proper operation, and filtering can break features such as optimizers and Companion calibration.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/configuration/settings.md` at line 37, Reword the warning
sentence that currently reads "*NOTE: Be certain to not filter out node IDs as
inter-node communication is required for proper operation and can break items
such as optimizers and Calibration in Companion.*" to a clearer, more idiomatic
phrasing—e.g., instruct readers not to filter node IDs and explain briefly that
inter-node communication is required for features like optimizers and
Calibration; update the sentence in src/content/docs/configuration/settings.md
replacing the current NOTE line with the clearer wording.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/content/docs/configuration/settings.md`:
- Line 37: Reword the warning sentence that currently reads "*NOTE: Be certain
to not filter out node IDs as inter-node communication is required for proper
operation and can break items such as optimizers and Calibration in Companion.*"
to a clearer, more idiomatic phrasing—e.g., instruct readers not to filter node
IDs and explain briefly that inter-node communication is required for features
like optimizers and Calibration; update the sentence in
src/content/docs/configuration/settings.md replacing the current NOTE line with
the clearer wording.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f6baeb0e-5041-461d-b273-73116867a6a2

📥 Commits

Reviewing files that changed from the base of the PR and between 564f3b7 and df03929.

📒 Files selected for processing (1)
  • src/content/docs/configuration/settings.md

@DTTerastar DTTerastar merged commit 9f5c158 into ESPresense:main Apr 29, 2026
1 check passed
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