MTA-6522 Added developer preview admonition for Python and nodejs providers#329
MTA-6522 Added developer preview admonition for Python and nodejs providers#329
Conversation
…viders Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
|
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 as they are similar to previous changes (1)
📝 WalkthroughWalkthroughReplaced Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
|
@mpershina Hello there! Please could you check if the Developer Preview looks alright? Many thanks! |
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/rules-development/yaml-provider-conditions.adoc`:
- Line 457: The cross-reference and provider naming are inconsistent: the xref
target `yaml-dotnet-provider_rules-prov-cond` and the actual anchor
`yaml-dotnet-provider_{context}` in yaml-provider-conditions.adoc clash with the
displayed "csharp" text and the target file yaml-dotnet-provider.adoc still uses
"dotnet"; fix by either (A) renaming the provider to "csharp" across the target
file and anchors—update yaml-dotnet-provider.adoc (title, example identifiers
like dotnet.referenced, internal anchors, and file name/IDs to use csharp) and
change the anchor to match `yaml-csharp-provider_rules-prov-cond`, or (B) keep
"dotnet" everywhere and change the xref on line 457 to reference the correct
existing anchor (e.g., `yaml-dotnet-provider_{context}` or
`yaml-dotnet-provider_rules-prov-cond`) and revert any "csharp" display text
back to "dotnet"; ensure all internal anchors, xref IDs, title, and example
identifiers (e.g., dotnet.referenced / csharp.referenced) are consistent after
the change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 4c75cce4-9d34-43ba-a8aa-c9143773803a
📒 Files selected for processing (1)
docs/topics/rules-development/yaml-provider-conditions.adoc
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/topics/rules-development/yaml-provider-conditions.adoc (1)
467-513:⚠️ Potential issue | 🟡 MinorAdd block continuations so this table cell renders correctly.
The new list/examples block is still missing
+continuations between each bullet and its source block, so the table cell rendering breaks in preview.Proposed fix
* Type reference including classes, interfaces and structure types (struct). For example: - + + [subs="+quotes"] ---- when: csharp.referenced: location: CLASS pattern: System.Web.Http.ApiController.* ---- - + + [subs="+quotes"] ---- when: csharp.referenced: location: ALL pattern: "System.Console.Print*" ---- * Method calls and definitions. For example: - + + [subs="+quotes"] ---- when: csharp.referenced: location: METHOD pattern: "*.AppDomain.Unload" ---- * Field usages and declaration. For example: - + + [subs="+quotes"] ---- when: csharp.referenced: location: FIELD pattern: "DotNetOpenAuth.AspNet.AuthenticationResult.Provider" ---- * Namespace imports and usages. For example: - + + [subs="+quotes"] ---- when: csharp.referenced: location: ALL pattern: "System.Windows.Forms" ----🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/rules-development/yaml-provider-conditions.adoc` around lines 467 - 513, The table cell's example blocks need AsciiDoc block continuations so each source block attaches to its preceding bullet: insert a single line containing a plus sign (+) between each bullet line and the following fenced source block for all four examples (the Type reference example with when: csharp.referenced / pattern System.Web.Http.ApiController.*, the pattern "System.Console.Print*" example, the Method calls example with pattern "*.AppDomain.Unload", the Field usages example with pattern "DotNetOpenAuth.AspNet.AuthenticationResult.Provider", and the Namespace imports example with pattern "System.Windows.Forms") so each bullet correctly continues into its subsequent [subs="+quotes"] ---- block.
🤖 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/rules-development/yaml-provider-conditions.adoc`:
- Around line 32-36: The preview warning incorrectly broadens scope by including
"Csharp" in the {FeatureName} attribute; update the attribute definition that
sets :FeatureName: so it lists only "Python and Nodejs providers" (remove
"Csharp") or, if C# truly is preview-only, update the PR description to state
that and keep "Csharp" but ensure the admonition text and heading consistently
reflect C# as Developer Preview; target the line that defines :FeatureName: and
the {FeatureName} usage so the admonition matches the intended preview scope.
---
Duplicate comments:
In `@docs/topics/rules-development/yaml-provider-conditions.adoc`:
- Around line 467-513: The table cell's example blocks need AsciiDoc block
continuations so each source block attaches to its preceding bullet: insert a
single line containing a plus sign (+) between each bullet line and the
following fenced source block for all four examples (the Type reference example
with when: csharp.referenced / pattern System.Web.Http.ApiController.*, the
pattern "System.Console.Print*" example, the Method calls example with pattern
"*.AppDomain.Unload", the Field usages example with pattern
"DotNetOpenAuth.AspNet.AuthenticationResult.Provider", and the Namespace imports
example with pattern "System.Windows.Forms") so each bullet correctly continues
into its subsequent [subs="+quotes"] ---- block.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b49624d9-2ef6-4c55-bfe9-9a9b8222bcef
📒 Files selected for processing (1)
docs/topics/rules-development/yaml-provider-conditions.adoc
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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/topics/rules-development/yaml-provider-conditions.adoc`:
- Around line 30-38: The FeatureName variable currently includes "C#, Python,
and Nodejs providers" but the PR description only mentions "Python and Node.js
providers"; either remove "C#" from the FeatureName declaration so it reads
"Python and Node.js providers" (update occurrences where FeatureName is used) or
update the PR description to explicitly include C# as part of the change (ensure
exact casing "C#" and "Node.js" are consistent). Locate the FeatureName symbol
in the document and make the change so the FeatureName value and PR
description/scope are consistent.
- Line 457: The cross-reference anchor IDs are wrong: change occurrences like
xref:yaml-dotnet-provider_rules-prov-cond[C#] to xref:yaml-dotnet-provider[C#]
to match the actual anchor (yaml-dotnet-provider_{context}); likewise update the
other provider xrefs that use the *_rules-prov-cond form (e.g.,
yaml-java-provider_rules-prov-cond, yaml-builtin-provider_rules-prov-cond,
yaml-go-provider_rules-prov-cond) to their correct anchors (yaml-java-provider,
yaml-builtin-provider, yaml-go-provider) so each xref matches the anchor names
in yaml-dotnet-provider.adoc.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1baeec2e-2d83-4a6c-9157-20a615e72742
📒 Files selected for processing (1)
docs/topics/rules-development/yaml-provider-conditions.adoc
|
@mguetta1 can you review as well please |
| :FeatureName: Dotnet provider | ||
| * `C#` | ||
|
|
||
| :FeatureName: C#, Python, and Nodejs providers |
There was a problem hiding this comment.
please check Nodejs.
I just think if we use Python then we might need to use Node.js
There was a problem hiding this comment.
I have changed it to the exact name of the providers than the programming language itself, thanks! :)
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
JIRA
Version
Preview
3.1. Provider condition Developer Preview Note
Summary by CodeRabbit