Add documentation for network-public-ip plugin
I've found out that the documentation for the network-public-ip plugin was missing.
This PR adds the docs of it, and add a missing space between the label and the IP value of it's output.
Thank you!
๐ Walkthrough
Walkthrough
This pull request adds documentation for a new network-public-ip option and updates the network-public-ip script to default the label to "IP" and emit the label and ip separated by a space.
Changes
| Cohort / File(s) | Summary |
|---|---|
Documentation updates docs/CONFIG.md |
Added network-public-ip entry under the network group and updated the table of contents; included description and a Nerdfont label example. |
Script label retrieval scripts/network-public-ip.sh |
Changed label retrieval to read a tmux option into a variable with default "IP" (instead of empty) and output the label and IP separated by a space. |
Estimated code review effort
๐ฏ 2 (Simple) | โฑ๏ธ ~8 minutes
- Check
scripts/network-public-ip.shfor correct default handling and output formatting (consumer expectations of "label ip" vs previous format). - Verify
docs/CONFIG.mdTOC link and example match the implemented output.
Pre-merge checks and finishing touches
โ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage | โ ๏ธ Warning | Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. | You can run @coderabbitai generate docstrings to improve docstring coverage. |
โ Passed checks (2 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | โ Passed | The title accurately describes the main objective of the PR: adding documentation for the network-public-ip plugin, which aligns with the primary changes in docs/CONFIG.md. |
| Description check | โ Passed | The description is directly related to the changeset, explaining both the documentation addition and the bug fix for the label-IP spacing in the plugin's output. |
โจ Finishing touches
๐งช Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
๐ Recent review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
๐ฅ Commits
Reviewing files that changed from the base of the PR and between 7f46e71ef853257f718d031991344d9cddd820d5 and 412cd20b4217518148a2c3c477d3f3f1b94d9430.
๐ Files selected for processing (1)
docs/CONFIG.md(2 hunks)
๐ง Files skipped from review as they are similar to previous changes (1)
- docs/CONFIG.md
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 help to get the list of available commands and usage tips.
Thank you very much for your contribution! I will gladly merge the docs, but the lack of a space is actually intentional, as it is supposed to be up to the users config how much white space there is.