testing: Set up placeholders for docs-examples-are-tests #3994
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I had previously prototyped an instance of this for the ImageOutput chapter. This patch makes empty placeholders for all of the other API chapters. They don't contain any actual tests or generate any output now, but they do build and run, so people can drop new examples into them without having to worry about how to set up new files for each chapter. Signed-off-by: Larry Gritz <lg@larrygritz.com>
jessey-git
reviewed
Sep 21, 2023
| # "example1" to a helpful short name that identifies the example. | ||
|
|
||
|
|
||
| # BEGIN-imageinput-example1 |
There was a problem hiding this comment.
Should be BEGIN-imagebuf-example1 (along with the END below)
jessey-git
approved these changes
Sep 21, 2023
Signed-off-by: Larry Gritz <lg@larrygritz.com>
|
Thanks. I tried to fix all my copy pasta, but it doesn't surprise me that I missed one. |
lgritz
added a commit
to lgritz/OpenImageIO
that referenced
this pull request
Sep 25, 2023
…wareFoundation#3994) I had previously prototyped an instance of this for the ImageOutput chapter. This patch makes empty placeholders for all of the other API chapters. They don't contain any actual tests or generate any output now, but they do build and run, so people can drop new examples into them without having to worry about how to set up new files for each chapter. --------- Signed-off-by: Larry Gritz <lg@larrygritz.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I had previously prototyped an instance of this for the ImageOutput chapter.
This patch makes empty placeholders for all of the other API chapters. They don't contain any actual tests or generate any output now, but they do build and run, so people can drop new examples into them without having to worry about how to set up new files for each chapter.