style(viewer): add docstrings#267
Merged
Merged
Conversation
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Contributor
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/expands docstrings across the viewer and rendering helpers to improve API clarity and maintainability.
Changes:
- Added class/function/method docstrings across viewer config, builder, and rendering helpers.
- Documented return value for
pointcloud_color. - Added a short description to
RenderingMode.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| t4_devkit/viewer/config.py | Adds a class-level docstring describing ViewerConfig attributes. |
| t4_devkit/viewer/color.py | Documents the return shape/type for pointcloud_color. |
| t4_devkit/viewer/builder.py | Adds docstrings to builder methods describing args/returns. |
| t4_devkit/helper/rendering.py | Adds docstrings for RenderingMode and lidarseg helper methods. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
What
This pull request primarily adds comprehensive docstrings to several classes and methods across the
t4_devkitcodebase, improving code readability and maintainability. The most important changes are grouped below by theme.Documentation improvements:
RenderingModeenum and its members inrendering.py, clarifying its purpose.ViewerBuilder(with_spatial3d,with_spatial2d,with_labels,with_streetmap,build) to describe their functionality, arguments, and return values. [1] [2]rendering.py(_has_lidarseg,_find_lidarseg_file) to explain their behavior.pointcloud_colorfunction incolor.pydescribing its return value.ViewerConfiginconfig.pydetailing its attributes.