Add explicit list of supported format in io documentation
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
The issue points to the API documentation for open3d.t.io.read_point_cloud; start there and inspect how the format parameter is documented. Consult the source code to identify the supported formats, then update the API docs to list them. Done when the documentation explicitly names the supported formats rather than only mentioning auto.
Written by the indexing model from the issue text.
Description
Checklist
- I have searched for similar issues.
- For Python issues, I have tested with the latest development wheel.
- I have checked the release documentation and the latest documentation (for
mainbranch).
Proposed new feature or change
In the API documentation for the io function for the format field it only mentions auto as an option, without and explicit list of formats that as supported. For example https://www.open3d.org/docs/release/python_api/open3d.t.io.read_point_cloud.html
Currently figuring out the list of supported formats requires digging into the source code.
References
No response
Additional information
No response
- Dominant language
- C++
- Stars
- 14.2k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from isl-org/Open3D
-
feature request
Difficulty 1/5 1-3 hours Newbie friendliness 76/100
-
Getting Started page gives incorrect link to development wheelsPossibly taken @SatvikMishra08 claimed this 31 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Window(title, width, height, flags) ignores the flags argumentPossibly taken @Wahaj18 claimed this 27 days ago. Openbug
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
compute_fpfh_feature stub incorrectly requires the optional indices argumentPossibly taken @huxiaoyi-ovo claimed this 31 days ago. Openbug
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
FilamentCamera::SetProjection(intrinsics, ...) places the principal point half a pixel off for OpenCV-convention intrinsicsPossibly taken @paneendrakumar0 claimed this 17 days ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Niko1221/Strata#5560 · 2 comments ·
Maintainers usually reply within 4 days
-
NVIDIA windows
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
kind/bug priority/medium qa_automation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
yugabyte/yugabyte-db#37324 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
CharlotteCross1998/awesome-game-decompilations#61 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
godotengine/godot#125240 ·
Maintainers usually reply within 1 day