docs: fix typo and malformed .NET link in Windows installation guide#266
docs: fix typo and malformed .NET link in Windows installation guide#266Tanush576 wants to merge 2 commits intoOpenMS:developfrom
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the Windows installation documentation: converts the top-level Windows heading to H1, fixes typos and punctuation (e.g., "installion" → "installation", "Run anyways" → "Run anyway"), normalizes Known Issues formatting, replaces a malformed .NET link with the Microsoft Learn page, and adds a Windows installer tip block. Changes
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/about/installation/installation-on-windows.md`:
- Around line 26-27: Fix the malformed quoted error message by removing the
stray apostrophe after SP1 and ensuring proper surrounding quotes; locate the
string "The installation of the Microsoft .NET 3.5 SP1' package failed!" in the
documentation and change it to a cleanly quoted message such as "The
installation of the Microsoft .NET 3.5 SP1 package failed!" so punctuation and
quoting are correct.
- Line 55: Change the unhyphenated phrase "third party tools (ProteoWizard)" to
the compound adjective form "third-party tools (ProteoWizard)" in the sentence
beginning "Fix is to enable the .NET Framework 3.5 yourself..." so the prose
uses the correct hyphenation for the compound modifier.
- Line 12: Replace the informal phrase in the user-facing sentence that reads
Click on "More Info", and then "Run anyways". in
docs/about/installation/installation-on-windows.md by changing "Run anyways" to
the standard form "Run anyway" so the sentence becomes Click on "More Info", and
then "Run anyway". Ensure only that wording is updated and punctuation remains
unchanged.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/about/installation/installation-on-windows.md`:
- Line 29: The document uses inconsistent casing for ProteoWizard: change the
phrase "Third Party - Proteowizard" to "Third Party - ProteoWizard" (match the
usage on Line 55) so the product name is consistently capitalized; search for
occurrences of "Proteowizard" in this file and update them to "ProteoWizard" to
standardize casing.
- Line 55: The sentence "Fix is to enable the .NET Framework 3.5 yourself
through Control Panel..." that documents Known issue 4 is not indented and
renders outside the numbered item; update the Markdown so that this sentence is
a continuation of list item "4." by indenting that line by four spaces (or one
tab) so it is nested under the "4." list item (edit the paragraph containing the
.NET Framework 3.5 guidance in the Known issue 4 block).
|
|
||
| You must download and install it manually in order for Proteowizard to work. | ||
| This should only happen if installion is done by selecting the "Third Party - Proteowizard" components. The reason is | ||
| This should only happen if installation is done by selecting the "Third Party - Proteowizard" components. The reason is |
There was a problem hiding this comment.
Use consistent product casing for ProteoWizard.
Line 29 says "Third Party - Proteowizard" while Line 55 uses ProteoWizard. Please standardize casing to avoid confusion.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/about/installation/installation-on-windows.md` at line 29, The document
uses inconsistent casing for ProteoWizard: change the phrase "Third Party -
Proteowizard" to "Third Party - ProteoWizard" (match the usage on Line 55) so
the product name is consistently capitalized; search for occurrences of
"Proteowizard" in this file and update them to "ProteoWizard" to standardize
casing.
| that `.net3.5` does not get properly installed during the process. | ||
|
|
||
| Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://docs.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows).aspx#ControlPanel) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third party tools (ProteoWizard). | ||
| Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third-party tools (ProteoWizard). |
There was a problem hiding this comment.
Fix list-item continuation formatting for Known issue 4.
Line 55 should be indented as part of list item 4.; currently it can render as a separate paragraph outside the numbered item.
Suggested edit
-Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third-party tools (ProteoWizard).
+ Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third-party tools (ProteoWizard).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third-party tools (ProteoWizard). | |
| Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third-party tools (ProteoWizard). |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/about/installation/installation-on-windows.md` at line 55, The sentence
"Fix is to enable the .NET Framework 3.5 yourself through Control Panel..." that
documents Known issue 4 is not indented and renders outside the numbered item;
update the Markdown so that this sentence is a continuation of list item "4." by
indenting that line by four spaces (or one tab) so it is nested under the "4."
list item (edit the paragraph containing the .NET Framework 3.5 guidance in the
Known issue 4 block).
Tanush576
force-pushed
the
fix-windows-install-docs
branch
from
d907b05 to
32e3c57
Compare
|
Hi maintainers! Just a quick update: I have accepted and merged all of the coderabbitai bot's suggestions for grammar and punctuation into this PR. |
2 participants
Describe the change
This PR fixes minor formatting and spelling errors in the Windows Installation "Known issues" section, addressing issue #265.
Changes made:
Fixes #265
Made with AI tools (Note: Used AI to assist with drafting the PR text and locating the updated Microsoft URL).
PR checklist
CHANGELOG.mdis updated.Summary by CodeRabbit