Add type hints to Python docs #4908
Merged
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
Signed-off-by: Connie Chang <[email protected]>
|
|
lgritz
approved these changes
Sep 27, 2025
Collaborator
lgritz
left a comment
lgritz
left a comment
There was a problem hiding this comment.
Looks good, thanks for the improvements! Merging.
|
|
||
|
|
||
| .. py::method:: TypeDesc.TypeDesc(typename='unknown') | ||
| .. py:method:: TypeDesc.TypeDesc(typename='unknown') |
lgritz
added
python
lgritz
pushed a commit
to lgritz/OpenImageIO
that referenced
this pull request
Sep 27, 2025
Closes AcademySoftwareFoundation#4752 Add Python type hints into documentation, in places where example code defines a function. That ended up being just `src/doc/pythonbindings.rst`. I also updated `testsuite/runtest.py` and the functions in `testsuite/docs-examples-python/src/docs-examples-*.py`. While I was in `pythonbindings.rst`, I noticed a couple places with `py::method` (note the double colon). These lines didn't render in the docs, so I removed the extra colon to match other usage. I locally built the docs to make sure html looks good. I ran the tests with `ctest` and the tests ran, so I'm taking that as a sign that `runtest.py` still works. Signed-off-by: Connie Chang <[email protected]>
Contributor
Author
|
Awesome, thank you @lgritz! |
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.
Description
Closes #4752
Add Python type hints into documentation, in places where example code defines a function. That ended up being just
src/doc/pythonbindings.rst. I also updatedtestsuite/runtest.pyand the functions intestsuite/docs-examples-python/src/docs-examples-*.py.While I was in
pythonbindings.rst, I noticed a couple places withpy::method(note the double colon). These lines didn't render in the docs, so I removed the extra colon to match other usage.Tests
I locally built the docs to make sure html looks good. I ran the tests with
ctestand the tests ran, so I'm taking that as a sign thatruntest.pystill works.Checklist:
need to update the documentation, for example if this is a bug fix that
doesn't change the API.)
(adding new test cases if necessary).
corresponding Python bindings (and if altering ImageBufAlgo functions, also
exposed the new functionality as oiiotool options).
already run clang-format before submitting, I definitely will look at the CI
test that runs clang-format and fix anything that it highlights as being
nonconforming.