Improve os config swap options argument (non-)completions#561
Improve os config swap options argument (non-)completions#561frenck merged 1 commit intohome-assistant:masterfrom
Conversation
📝 WalkthroughWalkthroughThe change updates the swappiness flag in the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant Shell
User->>Shell: Types command with --swap-size or --swappiness
Shell->>CLI: Requests completion options
CLI->>Shell: Returns valid values (swap-size: disables file completion, swappiness: 0-200)
Shell->>User: Presents valid completion options
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 golangci-lint (1.64.8)Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2 Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
✨ Finishing Touches
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:
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
cmd/os_config_swap_options.go(2 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
cmd/os_config_swap_options.go
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
cmd/os_config_swap_options.go
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
cmd/os_config_swap_options.go
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
cmd/os_config_swap_options.go
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
cmd/os_config_swap_options.go
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
cmd/os_config_swap_options.go
🔇 Additional comments (4)
cmd/os_config_swap_options.go (4)
5-5: Good addition of strconv import.The addition of the strconv package is necessary for the new completion function that converts integers to strings.
50-50: Good use of a constant for the maximum swappiness value.Defining maxSwappiness as a constant improves code maintainability by centralizing this value.
52-52: Good use of dynamic value in flag description.Using fmt.Sprintf to include the maxSwappiness constant in the flag description ensures the documentation stays in sync with the actual limit.
53-53: Good explicit disabling of file completions.Explicitly disabling file completions for the swap-size flag is appropriate since this parameter doesn't accept file paths.
2 participants
Summary by CodeRabbit
swap-sizeandswappinessflags, making it easier to select valid values.swappinessflag now displays its maximum value in the usage description for improved clarity.