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

docs(mocktail): improve argument matchers documentation in README #102

Merged
merged 5 commits into from Jan 10, 2022
Merged

docs(mocktail): improve argument matchers documentation in README #102

merged 5 commits into from Jan 10, 2022

Conversation

mousedownmike
Copy link
Contributor

@mousedownmike mousedownmike commented Dec 28, 2021

Status

READY

Breaking Changes

NO

Description

I found it difficult to follow the examples when creating stubs that matched named arguments. This is a first pass at trying to document the distinction between positional and named arguments. I'm very new to this library so it should be given a critical review.

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

@felangel felangel added the documentation Improvements or additions to documentation label Jan 10, 2022
Copy link
Owner

@felangel felangel left a comment

Choose a reason for hiding this comment

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

LGTM! 💯

@felangel felangel changed the title docs: separate examples for positional and named argument matchers docs(mocktail): improve argument matchers documentation in README Jan 10, 2022
@felangel felangel merged commit 70e915f into felangel:main Jan 10, 2022
@felangel felangel mentioned this pull request Mar 1, 2022
7 tasks
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.

None yet

2 participants