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

Consider removing old API syntax from documentation #239

Open
sv3ndk opened this issue Nov 28, 2022 · 2 comments
Open

Consider removing old API syntax from documentation #239

sv3ndk opened this issue Nov 28, 2022 · 2 comments

Comments

@sv3ndk
Copy link
Contributor

sv3ndk commented Nov 28, 2022

I am a newcomer to this project, I find it very useful, thanks for working on it.

When reading the documentation, I was puzzled at first to first read code snippets based on the ForEachTestContainer and ForAllTestContainer syntax, then to discover a new API based on TestContainerForAll and TestContainerForEach was now the recommended approach.

I understand the new API syntax has been around for about 3 years now, so I suggest to re-write all code snippets with it as well as Container.Def (most of which is already present in the "new API" section of the doc), and to either remove the mentions of the old syntax or to move it down to some "legacy" section or so.

This seems easy enough to do, so if you agree I'm happy to submit a minor PR with such change.

@dimafeng
Copy link
Collaborator

@sv3ndk Agree! Any help would be appreciated!

@sv3ndk
Copy link
Contributor Author

sv3ndk commented Nov 30, 2022

Great! I'll make time for that this week-end

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

2 participants