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

Add PonyCheck to the tutorial #499

Merged
merged 11 commits into from
Feb 26, 2022
Merged

Conversation

SeanTAllen
Copy link
Member

No description provided.

@SeanTAllen SeanTAllen added the do not merge This PR should not be merged at this time label Feb 22, 2022
@SeanTAllen SeanTAllen requested a review from a team February 22, 2022 21:45
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Feb 22, 2022
@SeanTAllen
Copy link
Member Author

Per the RFC, this content is repurposed from the PonyCheck README.

I'm trying to find a couple of good "introduction to property based testing" resources to include as well with the target audience of "people who know unit-testing and either don't know what property-based testing is or have heard of it but have never done it".

@SeanTAllen
Copy link
Member Author

SeanTAllen commented Feb 22, 2022

This will fail checks until the Ponyc PR is merged.

Also requires the PonyTest rename to be merged.

@SeanTAllen SeanTAllen marked this pull request as ready for review February 23, 2022 02:30
@SeanTAllen SeanTAllen mentioned this pull request Feb 23, 2022
65 tasks
@SeanTAllen
Copy link
Member Author

Shouldn't be merged until after pony 0.49.0 has been released.

Copy link
Member

@rhagenson rhagenson left a comment

Choose a reason for hiding this comment

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

I took a look at the raw file in addition to the diff. Raw file changes outside the diff are commented about below:

  • "Property based Testing first came up as..." -> "Property based testing first came up as..." i.e. lowercase "t"
  • "A Property needs a name" -> "A Property1 needs a name" ie add the "1"
  • "Below is a classical List reverse properties from the QuickCheck paper adapted to Pony Arrays" -> "Below is a classical List reverse properties from the QuickCheck paper adapted to Pony Arrays" ie add the code formatting for referenced data structures (or lowercase them so it is simply list and arrays which, to me, would then be generic and need no special formatting)
  • Many of the links are/will be broken right now, referring to addresses such as https://stdlib.ponylang.io/PonyCheck-Property1 rather than https://stdlib.ponylang.io/pony_check-Property1 ie correctly adding the underscore in "pony_check" per the rename

docs/testing/ponycheck.md Outdated Show resolved Hide resolved
docs/testing/ponycheck.md Outdated Show resolved Hide resolved
@SeanTAllen
Copy link
Member Author

@rhagenson can you do suggested changes for fixes or go ahead and edit directly and push?

@rhagenson
Copy link
Member

I can, yes. Give me a couple minutes to hop back on my laptop and the changes will be in place.

@SeanTAllen
Copy link
Member Author

I made what I could figure out.

@rhagenson
Copy link
Member

I will take a look now and push any remaining changes.

@rhagenson
Copy link
Member

@SeanTAllen My edits are in place now. You fixed much of what I had suggested as fixes already, but I found some inconsistencies in the URL used for the stdlib (.io versus .org), made a consistency edit to name PropertyHelper parameters the same across this page (as ph rather than h), and modified the language to avoid having to say "UnitTests" then linking to a page for singular "UnitTest" page.

@SeanTAllen SeanTAllen removed the do not merge This PR should not be merged at this time label Feb 26, 2022
@SeanTAllen SeanTAllen force-pushed the add-ponycheck-to-the-standard-library branch from 4609664 to 24a5dd0 Compare February 26, 2022 13:11
@SeanTAllen SeanTAllen merged commit 4789628 into main Feb 26, 2022
@SeanTAllen SeanTAllen deleted the add-ponycheck-to-the-standard-library branch February 26, 2022 13:15
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Feb 26, 2022
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.

3 participants