fix(api/docs): Fix IBA::set_pixels declaration and docs #4926
Conversation
This file contains hidden or 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
Two places where the docs and header for ImageBuf::set_pixels did not match. In one case, the docs were right, the declaration was supposed to have a parameter that was a `const image_span<T>&` but the `&` was left out. Now, if this was an actual linkable function, we wouldn't be able to fix it. But because it's a template and inline, I believe it is actually safe to fix it in situ without breaking ABI compatibility. In the second case, the header was correct but the docs used the wrong declaration (leaving out a `const`) and made the docs fail to pull in the right explanation. Fixes 4923 Signed-off-by: Larry Gritz <[email protected]>
EmilDohne
approved these changes
Oct 12, 2025
lgritz
added a commit
to lgritz/OpenImageIO
that referenced
this pull request
Oct 17, 2025
…areFoundation#4926) Two places where the docs and header for ImageBuf::set_pixels did not match. In one case, the docs were right, the declaration was supposed to have a parameter that was a `const image_span<T>&` but the `&` was left out. Now, if this was an actual linkable function, we wouldn't be able to fix it until a compatibility-breaking boundary. But because it's a template and inline, I believe it is actually safe to fix it in situ without breaking ABI compatibility (and it seems to pass our ABI check in CI). In the second case, the header was correct but the docs used the wrong declaration (leaving out a `const`) and made the docs fail to pull in the right explanation. Fixes AcademySoftwareFoundation#4923 Signed-off-by: Larry Gritz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Two places where the docs and header for ImageBuf::set_pixels did not match.
In one case, the docs were right, the declaration was supposed to have a parameter that was a
const image_span<T>&but the&was left out. Now, if this was an actual linkable function, we wouldn't be able to fix it until a compatibility-breaking boundary. But because it's a template and inline, I believe it is actually safe to fix it in situ without breaking ABI compatibility (and it seems to pass our ABI check in CI).In the second case, the header was correct but the docs used the wrong declaration (leaving out a
const) and made the docs fail to pull in the right explanation.Fixes #4923