MTA-6728 Visual Studio Code Plugin guide error fixes#339
Merged
Conversation
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughMinor documentation edits across VS Code extension docs: capitalization, grammar, whitespace, and small wording tweaks in procedure steps and metadata; no functional changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/topics/vscode/proc_vscode-analyzing-application.adoc`:
- Line 6: The sentence contains a duplicated preposition: "to which you want to
migrate the application to"; remove the trailing "to" so the phrase reads
correctly (e.g., "technologies to which you want to migrate the application"),
updating the sentence in
docs/topics/vscode/proc_vscode-analyzing-application.adoc accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d213831b-744f-4a8c-9805-5e5a0dc36c89
📒 Files selected for processing (6)
docs/topics/vscode/proc_configuring-profile-settings.adocdocs/topics/vscode/proc_installing-analyzer-binary-locally.adocdocs/topics/vscode/proc_installing-vscode-extension.adocdocs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adocdocs/topics/vscode/proc_vscode-analyzing-application.adocdocs/vs-code-extension-guide/master-docinfo.xml
|
|
||
| [role="_abstract"] | ||
| You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies which you want to migrate the application to. | ||
| You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application to. |
Contributor
There was a problem hiding this comment.
Remove duplicated preposition in migration-target sentence.
Line 6 currently says “to which you want to migrate the application to,” which is grammatically incorrect due to the extra trailing “to.”
✏️ Proposed fix
-You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application to.
+You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application.📝 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.
Suggested change
| You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application to. | |
| You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/topics/vscode/proc_vscode-analyzing-application.adoc` at line 6, The
sentence contains a duplicated preposition: "to which you want to migrate the
application to"; remove the trailing "to" so the phrase reads correctly (e.g.,
"technologies to which you want to migrate the application"), updating the
sentence in docs/topics/vscode/proc_vscode-analyzing-application.adoc
accordingly.
Collaborator
There was a problem hiding this comment.
Full name first, then it's abbreviation (style guidelines); also, an extra "to" at the rnd
Suggested change
| You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The RPC (Remote Procedure Call) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application to. | |
| You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The Remote Procedure Call (RPC) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application. |
Contributor
There was a problem hiding this comment.
@mpershina, you're absolutely right on both counts — thank you for the catch! My original suggestion addressed the duplicate "to" but missed the abbreviation ordering style guideline. Your revised suggestion correctly:
- Expands the acronym first: "Remote Procedure Call (RPC)" instead of the reverse.
- Drops the trailing "to" — so the sentence ends cleanly with "…to which you want to migrate the application."
The updated line should read:
You can run a static code analysis of an application with or without enabling the Generative AI (GenAI) features. The Remote Procedure Call (RPC) server runs the analysis to detect all issues in the code for one or more target technologies to which you want to migrate the application.
ʕ •ᴥ•ʔ 🐇
✏️ Learnings added
Learnt from: mpershina
Repo: migtools/mta-documentation PR: 339
File: docs/topics/vscode/proc_vscode-analyzing-application.adoc:6-6
Timestamp: 2026-04-09T08:49:54.549Z
Learning: In migtools/mta-documentation, follow the style guideline that the full name of an acronym/abbreviation must appear first, followed by the abbreviation in parentheses (e.g., "Remote Procedure Call (RPC)" not "RPC (Remote Procedure Call)"). Apply this to all documentation files in the repository.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
🧠 Learnings used
Learnt from: Pkylas007
Repo: migtools/mta-documentation PR: 329
File: docs/topics/rules-development/yaml-provider-conditions.adoc:457-457
Timestamp: 2026-03-18T08:59:21.462Z
Learning: In migtools/mta-documentation, do not flag or review cross-reference (xref) anchor ID mismatches or broken xrefs in AsciiDoc (.adoc) files. Maintainers have explicitly requested ignoring xref issues for this repository. Apply this guidance to all .adoc files in the project (pattern: **/*.adoc); do not raise xref-related review comments for these files unless the directive is explicitly lifted.
Learnt from: Pkylas007
Repo: migtools/mta-documentation PR: 326
File: assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc:20-20
Timestamp: 2026-03-30T15:14:19.266Z
Learning: In this repository’s AsciiDoc (.adoc) files, follow Red Hat documentation style for the specific construct: it’s acceptable to use a sentence fragment that starts with “For example, …” as a standalone sentence when it follows a preceding complete statement. Do not flag this as an AsciiDoc grammar or readability issue.
Contributor
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
mpershina
requested changes
Apr 9, 2026
Collaborator
mpershina
left a comment
mpershina
left a comment
There was a problem hiding this comment.
One minor fix needed, otherwise, LGTM!
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JIRA
Version
Preview
Summary by CodeRabbit