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

Fix sample code in the docs #36

Merged
merged 1 commit into from
Feb 22, 2024
Merged

Conversation

greg0ire
Copy link
Contributor

@greg0ire greg0ire commented Feb 15, 2024

If you try compiling the code in the quickstart guide, it will error out because RunDefaultContainerAndStopOnCleanup does not take an option argument.

Switching to RunContainerAndStopOnCleanup seems to do the trick although I'm not sure at all whether this is the right function since this is my first try at using this library.

Submitter checklist

  • Recommended: Join WireMock Slack to get any help in #help-contributing or a project-specific channel like #wiremock-java
  • The PR request is well described and justified, including the body and the references
  • The PR title represents the desired changelog entry
  • The repository's code style is followed (see the contributing guide)
  • Test coverage that demonstrates that the change works as expected
  • For new features, there's necessary documentation in this pull request or in a subsequent PR to wiremock.org

Copy link
Contributor

@jamietanna jamietanna left a comment

Choose a reason for hiding this comment

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

Looks like a reasonable change, but I'd say possibly a docs: change rather than a fix: 👍

If you try compiling the code in the quickstart guide, it will error out
because RunDefaultContainerAndStopOnCleanup does not take an option
argument.

Switching to RunContainerAndStopOnCleanup seems to do the trick although
I'm not sure at all whether this is the right function since this is my
first try at using this library.
@greg0ire
Copy link
Contributor Author

@jamietanna addressed

@oleg-nenashev oleg-nenashev added the documentation Improvements or additions to documentation label Feb 22, 2024
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Seems to be a copy-paste issue, thank you!

@oleg-nenashev oleg-nenashev merged commit 3308783 into wiremock:main Feb 22, 2024
1 check passed
@greg0ire greg0ire deleted the fix-docs branch February 22, 2024 18:43
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.

3 participants