MTA-6730 Rules Development error fixes by Pkylas007 · Pull Request #341 · migtools/mta-documentation

Pkylas007 · 2026-04-07T06:05:37Z

JIRA

MTA-6730 [DOC] Configuring and using rules for an MTA analysis - Typos and Grammar

Version

8.2.0

Preview

Summary by CodeRabbit

Documentation
- Fixed formatting inconsistencies including spacing, punctuation, and capitalization across rules development guides
- Updated provider condition notation for consistency and clarity
- Enhanced grammar and phrasing in YAML documentation examples and descriptions

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>

coderabbitai · 2026-04-07T06:05:53Z

Warning

Rate limit exceeded

@Pkylas007 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 21 minutes and 19 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 21 minutes and 19 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6a9a92f9-2b6b-48ca-a174-4441d3eb98ee

📥 Commits

Reviewing files that changed from the base of the PR and between 3127601 and 82b6202.

📒 Files selected for processing (2)

assemblies/rules-development-guide/assembly_rule-yaml-conditions.adoc
docs/topics/rules-development/yaml-rulesets.adoc

📝 Walkthrough

Walkthrough

Minor documentation updates across multiple files including grammar corrections, phrasing refinements, punctuation adjustments, capitalization consistency, and provider identifier normalization. All changes are documentation-only with no functional impact to code or APIs.

Changes

Cohort / File(s)	Summary
Grammar and Punctuation Fixes `assemblies/rules-development-guide/assembly_rule-rulesets.adoc`, `docs/topics/rules-development/create-first-yaml-rule.adoc`, `docs/topics/rules-development/create-python-custom-rule.adoc`, `docs/topics/rules-development/yaml-rulesets.adoc`	Removed extra spaces and adjusted punctuation for consistency (space before colons, sentence-ending periods).
Phrasing and Clarity Updates `assemblies/rules-development-guide/assembly_rule-yaml-conditions.adoc`, `docs/topics/rules-development/yaml-builtin-provider.adoc`, `docs/topics/rules-development/yaml-message-actions.adoc`, `docs/topics/rules-development/yaml-chaining-condition-variables.adoc`	Refined wording for improved clarity and consistency (e.g., "it has" vs "contains," explicit article usage, capitalization of "Mustache").
Provider Identifier Normalization `docs/topics/rules-development/yaml-provider-conditions.adoc`	Normalized C\# provider condition token from `C#` to `csharp` across multiple documentation sections and references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

MTA-6471 C# Provider Documentation #309: Updates provider identifier normalization (C\# → csharp) in the same yaml-provider-conditions.adoc file.
MTA-6715 Heading Fixes #337: Modifies yaml-chaining-condition-variables.adoc with similar documentation refinements.
CQA 2.1: Rules Development Guide Feb 26 #308: Makes comparable minor editorial corrections across overlapping documentation files.

Suggested reviewers

anarnold97
mguetta1
mpershina

Poem

🐰 A comma here, a space right there,
Documentation brushed with care!
Our words now dance with proper grace,
Each provider in its rightful place. ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately reflects the main changes in the pull request—documentation fixes for typos and grammar errors across the Rules Development documentation files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch mta-6730-rules-error-fixes

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

mpershina · 2026-04-09T08:53:45Z

 *  Replace `<output_dir>` with the directory of your choice.
 *  Replace `<custom_rule_dir>` with the custom rule file.
-* To use multiple rule files, you need to place them in a directory and to add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.
+* To use multiple rule files, you need to place them in a directory and add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.


Just a suggestion

Suggested change

* To use multiple rule files, you need to place them in a directory and add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.

* To use multiple rule files, place them in a directory and add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.

Done, thank you!

mpershina · 2026-04-09T08:55:42Z

 In a rule, the when block is where the conditions for matching the rule are specified. Each provider offers a series of capabilities to do matching. The search query in the rule condition can contain patterns, code locations, specific dependencies to be found, and so on, to evaluate the source code and dependencies. The provider sends the LSP server a request to check the search query against the application being analyzed. When the LSP server returns a match for the search in the source code, the analyzer triggers a violation.

-The syntax for the when block is as follows: contains one condition, but that condition can have multiple conditions nested under it.
+The syntax for the when block is as follows: it has one condition, but that condition can have multiple conditions nested under it.


I think we should use some markup for the when block. I also suggested a small rewrite to simplify the sentence:

Suggested change

The syntax for the when block is as follows: it has one condition, but that condition can have multiple conditions nested under it.

The `when` block has one condition, but that condition can have multiple conditions nested under it:

Done, thanks!

mpershina

A couple of fixes needed, otherwise, LGTM!

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>

MTA-6730 Rules Development error fixes

3127601

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>

Pkylas007 requested a review from anarnold97 April 7, 2026 09:23

mpershina reviewed Apr 9, 2026

View reviewed changes

mpershina requested changes Apr 9, 2026

View reviewed changes

Made a couple of corrections

82b6202

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>

Pkylas007 merged commit 7d0f0f3 into main Apr 9, 2026
1 of 2 checks passed

This was referenced Apr 10, 2026

MTA-6448 Rules Development guide DITA modifications #349

Merged

MTA-6757 Formatting Fixes #353

Merged

coderabbitai Bot mentioned this pull request Apr 20, 2026

MTA-6826, 6827, 6828, 6829, 6830, 6831 CQA April work for rules development guide #359

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MTA-6730 Rules Development error fixes#341

MTA-6730 Rules Development error fixes#341
Pkylas007 merged 2 commits intomainfrom
mta-6730-rules-error-fixes

Pkylas007 commented Apr 7, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 7, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

mpershina Apr 9, 2026

Uh oh!

Pkylas007 Apr 9, 2026

Uh oh!

mpershina Apr 9, 2026

Uh oh!

Pkylas007 Apr 9, 2026

Uh oh!

mpershina left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	* To use multiple rule files, you need to place them in a directory and add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.
	* To use multiple rule files, place them in a directory and add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.

	The syntax for the when block is as follows: it has one condition, but that condition can have multiple conditions nested under it.
	The `when` block has one condition, but that condition can have multiple conditions nested under it:

Conversation

Pkylas007 commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

JIRA

Version

Preview

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

mpershina Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Pkylas007 Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

mpershina Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Pkylas007 Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

mpershina left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Pkylas007 commented Apr 7, 2026 •

edited

Loading

coderabbitai Bot commented Apr 7, 2026 •

edited

Loading