Skip to content
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

Actualize rule example in docs, rename $ruleContext to $context #259

Merged
merged 3 commits into from
Feb 29, 2024

Conversation

arogachev
Copy link
Contributor

@arogachev arogachev commented Feb 29, 2024

Q A
Is bugfix?
New feature?
Breaks BC?

Thanks to @vjik for discovering.

@arogachev arogachev requested a review from a team February 29, 2024 07:43
@arogachev arogachev self-assigned this Feb 29, 2024
Copy link

what-the-diff bot commented Feb 29, 2024

PR Summary

  • Method Signature Update in ActionRule
    The execute method within ActionRule has been modified. Now, it accepts not only a user ID, which can be empty, but also an object named RuleContext. This change enables the method to check if a user's action matches a preset value—in this case, 'home'—and make decisions based on that.

  • Documentation Comments Improved
    The explanations given in the code's commentary have been updated to reflect these modifications in the execute method. This ensures all developers can understand and use this function correctly.

@arogachev arogachev added this to the 2.0 milestone Feb 29, 2024
@arogachev arogachev added the type:docs Documentation label Feb 29, 2024
@arogachev arogachev changed the title Actualize rule example in docs Actualize rule example in docs, rename $ruleContext to $context Feb 29, 2024
Copy link

codecov bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (44912db) to head (b76fb91).

❗ Current head b76fb91 differs from pull request most recent head 0417de5. Consider uploading reports for the commit 0417de5 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##              master      #259   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       222       222           
===========================================
  Files             14        14           
  Lines            552       552           
===========================================
  Hits             552       552           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@arogachev arogachev added the status:code review The pull request needs review. label Feb 29, 2024
@arogachev arogachev merged commit d3300e1 into master Feb 29, 2024
2 checks passed
@arogachev arogachev deleted the docs-rules branch February 29, 2024 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:code review The pull request needs review. type:docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants