Skip to content

Conversation

@AidenFuller
Copy link
Contributor

Clarify the use of the 'Name' property in StepArgumentTransformation.

🤔 What's changed?

Updated documentation to improve clarity around the intended usage of the "Name" property for StepArgumentTransformation

⚡️ What's your motivation?

  • Resolves a discussion question
  • Clarity!!

🏷️ What kind of change is this?

  • 📖 Documentation (improvements without changing code)

♻️ Anything particular you want feedback on?

Correctness :)

📋 Checklist:

  • I have updated the documentation accordingly.

Clarify the use of the 'Name' property in StepArgumentTransformation.
@304NotModified
Copy link
Member

304NotModified commented Dec 19, 2025

@gasparnagy adding you as reviewer as I'm not 100% sure (see https://github.com/orgs/reqnroll/discussions/974#discussioncomment-15294889)

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation for the StepArgumentTransformation attribute to clarify the purpose and behavior of the Name property. The update addresses a community discussion question by explaining that while the Name property allows parameters to be specified with that name in Cucumber expressions, it doesn't enforce strict scoping and is primarily intended for clarity.

Key Changes:

  • Added documentation explaining the Name property's purpose for specifying parameter names in Cucumber expressions
  • Clarified that the Name property doesn't enforce strict scoping but serves as a clarity mechanism

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@304NotModified 304NotModified added the documentation Improvements or additions to documentation label Dec 19, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@304NotModified
Copy link
Member

/home/runner/work/Reqnroll/Reqnroll/docs/automation/step-argument-conversions.md:105: WARNING: 'myst' cross-reference target not found: 'cucumber-expressions#parameters' [myst.xref_missing]

Copy link
Contributor

@gasparnagy gasparnagy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy with the text, if we fix the ref issue, it can be merged.

Corrected link to parameters documentation in step-argument-conversions.md.
Copy link
Contributor

@gasparnagy gasparnagy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx

@gasparnagy gasparnagy merged commit eb21eb0 into reqnroll:main Jan 6, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants