Enhance documentation and accessibility with code examples explaining the rationale about jqwik HOT 11 CLOSED

from jqwik.

Can you have a look at the current documentation and tell me if it covers your needs?

http://jqwik.net/user-guide.html

from jqwik.

I have problems comprehending the section about combining arbitraries, the example is not using a combiner at all.

from jqwik.

from jqwik.

Nevermind, just found the examples in test. I was confused that there is an example source set and an examples package in test.

from jqwik.

Add a few pages to document the common features. Maybe the classes in examples package should be extracted into source set of its own.

from jqwik.

Maybe it would also make sense to open a gitter channel? Would be nice to have a discussion ground beneath the github issue tracker.

from jqwik.

@DennisRippinger I fixed it. Have a look!

from jqwik.

Much better, thanks

from jqwik.

Looks pretty solid to me. However, in How to use you say that the engine can be used with other engines. Can you provide an example for this? A quick glance into the JUnit 5 docs did not reveal to me how I can run two engines on the same codebase.

Maybe a little migration guide would be helpful?

from jqwik.

@gtrefs Added a little bit in user guide about combining with other engines.
Migration guide would be an involved endeavour and thus require a new issue...

Closing this issue. Please create a new one for specific ideas about documentation.

from jqwik.