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

Please consider updating documentation to v3 before adding new functionality #698

Open
OmanF opened this issue Feb 26, 2025 · 0 comments
Open

Comments

@OmanF
Copy link

OmanF commented Feb 26, 2025

Since the APIs have all been updated to v3, but the documentation is still for v2, a mismatch, that is clearly stated, that's true, occurs.
Since you follow SemVer, the move to v3 introduced a lot of breaking changes, up to the point where simple documented code like: Gen.oneof [ gen { return true }; gen { return false } ] is no longer valid.

I tried looking at the API documentation, the only part of the documentation that is always true since it's generated directly from source code (also, stated in the docs clearly)... I couldn't figure out how to create this one simple, it doesn't get any simpler than this one, generator anymore.

Now, personally, I'm doing mostly hobby-coding, I can stay on v2 indefinetly.

But please consider updating the docs, at least to a minimal-viable-documentation state, where a new user to the package can get any tests going.

As it is, if I were new to the package, seeing the mismatch (yes, clearly documented), trying out the examples only to fail, looking at the API documenatation, that I can't understand... I'd give up right there and then.

To put in another way, if you keep updating the API and functionality, but not the documentation, you're basically turning FsCheck into you pet, hobby, project, because you would be the only ones able to exercise it.
THAT would be a real shame since FsCheck is still F#'s premier proprety-based testing framework (despite the competition), and losing it would be a loss.

(And, to answer the most obvious comment I can antecipate... like I said, if I understood the API documentation, I'd be happy to make little, step-by-step, efforts to help. As it is, I can't figure out how to translate the (very) simple above code to the new v3 API, let alone re-write the complex examples in the v2 documentation).

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

1 participant