Add missing keyword arg names to visualization bindings #6407
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.
Type
Motivation and Context
I was using the python visualization API, and I noticed that some of the keyword arguments in the python bindings show up as "arg0" "arg1" etc. This made it confusing, because I had to keep switching between the python API and the source code to see what the arguments really meant. This adds the missing argument names.
Checklist:
python util/check_style.py --apply
to apply Open3D code styleto my code.
updated accordingly.
results (e.g. screenshots or numbers) here.
Description
Before, if I ran something like
help(open3d.visualization.Visualizer.reset_view_point)
, I would get a message that looks like this (notice thearg0
):Now it looks like this:
I have added similar fixes for other functions in
open3d.visualization
. I believe this is the only module where the keyword arguments were missing in the python docs. InO3DVisualizer
, some of the documentation style was inconsistent, so I cleaned that up, too.I checked the generated html docs and verified that the results look okay. Let me know if you'd like any other changes.
This change is