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

Documentation for GENERATE macro and generators? #988

Closed
RossBencina opened this issue Aug 7, 2017 · 2 comments
Closed

Documentation for GENERATE macro and generators? #988

RossBencina opened this issue Aug 7, 2017 · 2 comments

Comments

@RossBencina
Copy link
Contributor

Description

Catch appears to support test data generation via the GENERATE macro. See the examples here:

https://github.com/philsquared/Catch/blob/master/projects/SelfTest/GeneratorTests.cpp

I have been unable to locate any documentation that references GENERATE or the other syntax used in GeneratorTests.cpp

Steps to reproduce

Search for GENERATE on the documentation pages.

Questions

  • Does the documentation exist?
  • Is GENERATE a supported feature? I have found it useful on the few occasions that I've used it.
  • Are there more examples somewhere?
  • Could we at least add a stub documentation page to reference the feature?
@philsquared
Copy link
Collaborator

Hi @RossBencina,

  1. Documentation does not exist. This is deliberate because...
  2. ... This is not a supported feature. It was originally experimental - but hit some systemic issues that caused a rethink (and some preparatory rework). There's a new implementation off to the side (not in GitHub) that works properly, but is not finished. This will be going into Catch2.
  3. No (not for this implementation)
  4. You raise a good point, indirectly, that the lack of documentation does not adequately convey the unsupported nature.

The original implementation went in quite early on and got stuck there. I know some people have used it, so I didn't want to take it out. The main problem with it (apart from being incomplete) is it doesn't work with sections.

@philsquared
Copy link
Collaborator

I'm going to close this issue as the future facing aspect is covered by #850.

But let me know if you have any more questions, @RossBencina

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