Document required step before full test suite can be executed #2466
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe document Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DevContainer
participant TestSuite
User->>DevContainer: Activate virtual environment
DevContainer->>User: Virtual environment activated
User->>DevContainer: Run command `uv pip install -r requirements_test_all.txt`
DevContainer->>User: Install additional dependencies
User->>TestSuite: Run full test suite
TestSuite->>User: Test results
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 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: 0
🧹 Outside diff range and nitpick comments (1)
docs/development_testing.md (1)
20-25: Improve clarity and directness of the instructionThe addition of this critical step is valuable. However, the instruction could be more direct and authoritative.
Apply this diff to improve the instruction:
-If you want to run the full test suite, you need to install all dependencies. Activate the virtual environment and run the command: +Install all dependencies before running the full test suite:Additionally, consider consolidating this instruction with the similar one in the "Adding new dependencies" section to avoid redundancy.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/development_testing.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/development_testing.md (6)
Pattern */**(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'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
docs/development_testing.md
Outdated
| @@ -17,6 +17,12 @@ To run our linters, on the full code base, run the following command: | |||
| pre-commit run --all-files | |||
| ``` | |||
|
|
|||
| If you want to run the full test suite, you need to install all dependencies. Activate the virtual environment and run the command: | |||
There was a problem hiding this comment.
maybe move this up to L12 and start with something like "If not using the VSCode devcontainer.....", since the sentence on L12 mentions how to run the tests using devcontainer, and this is an alternative to it
There was a problem hiding this comment.
Apparently it wasn't clear that this is a step required when using devcontainers.
I have moved it to the getting started section of devcontainer instead.
Hopefully this is more clear?
There was a problem hiding this comment.
Sorry I'm going to counter review this.
Most people really do not need this. This should suggestion and change should be undone.
There was a problem hiding this comment.
I have reverted the change to the original place.
But reworded it a bit to hopefully make it more clear.
There was a problem hiding this comment.
I agree with @frenck that this should not be on the devcontainer section. My suggestion was to place it after that sentence on L12 with a different wording (see my original comment above).
L12 states: This can be achieved by using the VScode devcontainer and the corresponding task., because the vscode tasks install all the dependencies automatically, thus it is not needed if people use the devcontainer and the vscode tasks. But for someone not using vscode, this is needed.
There was a problem hiding this comment.
@abmantis Is this phrasing better?
To run the full test suite, more dependencies are required than what is setup in the devcontainer by default.
If you are running the vscode remote container, you can execute the 'Install all test requirements' task for this.
Or you can activate the virtual environment and run the command:
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
docs/development_environment.mdx (1)
Line range hint
4-13: Improve type safety and accessibility of the RepositoryOpener componentSeveral improvements can be made to enhance the component's robustness:
export const RepositoryOpener = () => { - const [value, setValue] = useState(0); + const [value, setValue] = useState(""); const repoUrl = `vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=${encodeURIComponent(value)}`; return <div> - <input onInput={(ev) => setValue(ev.target.value)} style={{width: "80%", display: "inline-block", marginRight: 16}} /> - <a href={repoUrl}><button style={{cursor: value == "" ? "default" : "pointer"}} disabled={value == ""}>Open</button></a> + <input + aria-label="Repository URL" + placeholder="Enter repository URL" + onChange={(ev) => setValue(ev.target.value)} + style={{width: "80%", display: "inline-block", marginRight: 16}} + /> + <a href={repoUrl}><button style={{cursor: value === "" ? "default" : "pointer"}} disabled={value === ""}>Open</button></a> </div> }🧰 Tools
🪛 LanguageTool
[style] ~48-~48: Consider a more expressive alternative.
Context: ...o run hass and pytest are installed. To do this, run `uv pip install -r requiremen...(DO_ACHIEVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/development_environment.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/development_environment.mdx (6)
Pattern */**(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'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🪛 LanguageTool
docs/development_environment.mdx
[style] ~48-~48: Consider a more expressive alternative.
Context: ...o run hass and pytest are installed. To do this, run `uv pip install -r requiremen...
(DO_ACHIEVE)
MartinHjelmare
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/development_testing.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/development_testing.md (6)
Pattern */**(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'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🪛 LanguageTool
docs/development_testing.md
[grammar] ~20-~20: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ... dependencies are required than what is setup in the devcontainer by default. To inst...
(BE_VB_OR_NN)
🔇 Additional comments (1)
docs/development_testing.md (1)
20-25: LGTM! Documentation improvement helps new developers
The added instructions clearly explain the additional step required to run the full test suite, which addresses the PR's objective of helping new developers.
🧰 Tools
🪛 LanguageTool
[grammar] ~20-~20: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ... dependencies are required than what is setup in the devcontainer by default. To inst...
(BE_VB_OR_NN)
|
Fixes #2061. |
Proposed change
Minor fix to make it easier for new people who start development and want to try running the full test suite.
Type of change
Additional information
Summary by CodeRabbit