-
Notifications
You must be signed in to change notification settings - Fork 107
Update documentation on StepArgumentTransformation #975
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Clarify the use of the 'Name' property in StepArgumentTransformation.
|
@gasparnagy adding you as reviewer as I'm not 100% sure (see https://github.com/orgs/reqnroll/discussions/974#discussioncomment-15294889) |
There was a problem hiding this 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
Nameproperty's purpose for specifying parameter names in Cucumber expressions - Clarified that the
Nameproperty 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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
gasparnagy
left a comment
There was a problem hiding this 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.
gasparnagy
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thx
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?
🏷️ What kind of change is this?
♻️ Anything particular you want feedback on?
Correctness :)
📋 Checklist: