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 code example error in stateful docs #1642

Merged
merged 1 commit into from
Oct 18, 2018

Conversation

nmbrgts
Copy link
Contributor

@nmbrgts nmbrgts commented Oct 18, 2018

Hello again! I noticed this small mistake in the stateful docs: the docs suggest settings can be set at FiniteStateMachine.settings when it is actually at FiniteStateMachine.TestCase.settings.

I realize that this is a pretty light PR. If that is a problem, I'd be happy to flesh this PR out with additional doc improvements. I could add some notes on using @settings(...) with state machines (... which I probably should have done in my last PR). I'm open to other suggestions too 😄

Copy link
Member

@Zac-HD Zac-HD left a comment

Choose a reason for hiding this comment

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

Small PRs are great! If you had multiple one-line changes which each needed a release we would probably consolidate them, but for documentation or test changes the only limit is waiting for CI 😄

@Zac-HD Zac-HD merged commit 0b9d1a5 into HypothesisWorks:master Oct 18, 2018
@Zac-HD
Copy link
Member

Zac-HD commented Oct 18, 2018

FYI this also prompted me to ask "how could we help users get this right" (one of my favorite questions), and #1643 has my notes on how to enforce it at runtime. That's a whole separate problem to fixing the docs though!

@nmbrgts
Copy link
Contributor Author

nmbrgts commented Oct 18, 2018

Thanks for the clarification on small PRs! I'll take a look at your notes as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants