Documentation not available in C# and/or VB.net

[martijnhoekstra]

Though the documentation indicates it should be possible to write specifications in C# and/or VB, all documentation assumes F# throughout, making it difficult to work with for people with little or no experience with F#.

[Andrea]

Good point!

[mavnn]

@martijnhoekstra It's not documentation as such, but there's example usage and code in my blog post at: http://blog.mavnn.co.uk/property-checking-start-challenge/

Hope that gives you a starter until someone gets a chance to document further. (There is F# code in the blog too, but feel free to ignore that :) )

[martijnhoekstra]

That's a great start, thanks! I'll see if I can work through them, and possible provide pull requests for the docs as I go along. Something quicktestlike is sorely needed for the whole .NET ecosystem, not just F#

[kurtschelfthout]

Although I'm supportive of writing docs for the existing API, I would be vastly more supportive of taking a good look at the api and possibly completely revamping it. Also, there are some fairly annoying limitations with it. I'm sure actually translating the examples on the docs to C# would reveal them.

[mausch]

I've been using FsCheck in C# for quite some time now and the API feels pretty decent. I started with the samples ( https://github.com/fsharp/FsCheck/blob/master/examples/FsCheck.CSharpExamples/Program.cs ), after that Intellisense and types guide you, and whenever I found something missing I just contributed the trivial wrapper for it.

This is not to say that some documentation wouldn't be nice, but I don't see the annoying limitations... do you have any concrete examples? Maybe an idea of what a better C# API would look like?

[mausch]

The only real annoyance I've found is sometimes forgetting the .QuickCheck() / .QuickCheckThrowOnFailure() at the end of a Spec definition to actually run it, but that's also kinda my fault for not using the proper test framework integration, which is a separate issue.

[kurtschelfthout]

See also #63 for my ideas around revamping the API.

[kurtschelfthout]

Ping! See #63 and the docs I just uploaded for some progress on this. Let me know what you think.

[kurtschelfthout]

Going to close this, as the bulk of the docs now have side by side examples in F# and C#. Please open a separate issue or even better, a PR, if you think docs are lacking somewhere. It should be relatively straightforward to add C# snippets to the CSharp.Snippets project, and reference from the FSharp.Formatting fsx files.