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 for beginners #31

Open
slimshader opened this issue Nov 29, 2024 · 2 comments
Open

Docs for beginners #31

slimshader opened this issue Nov 29, 2024 · 2 comments

Comments

@slimshader
Copy link

Hey, new to property/random testing and love the concept so far.

The problem is not sure how to start with CsCheck I am especially interested in Model-based testing (if I understand it correctly but no Idea what SetSlim is.

Any chance of makig the docs but more beginner-firendly?

Btw, I am using CsCheck for Unity projects.

@AnthonyLloyd
Copy link
Owner

AnthonyLloyd commented Nov 29, 2024

Hi, sorry I don't have any current plans for more docs. I just have the README and there are Xml Docs on the API and the tests give some examples.

@pppls
Copy link
Contributor

pppls commented Dec 5, 2024

It's true that some doc elements are a bit curt which may make them more difficult to understand. However you can typically find the actual test in the source code which will give you a bit more context. For example, the SetSlim example you're likely referring to

    [Fact]
    public void SetSlim_ModelBased()
    {
        Gen.Int.Array.Select(a => (new SetSlim<int>(a), new HashSet<int>(a)))
        .SampleModelBased(
            Gen.Int.Operation<SetSlim<int>, HashSet<int>>(
                (ss, i) => ss.Add(i),
                (hs, i) => hs.Add(i)
            )
        );
    }

can be found in SlimCollectionsTests.cs.

So I would recommend cloning the package and just investigating that way if you don't understand something.

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

No branches or pull requests

3 participants