Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for #7149 + proposed readme for docker on Windows + fixing typos #7150

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

joseph-sch
Copy link

@joseph-sch joseph-sch commented Jan 27, 2025

Type

Motivation and Context

  1. There is a typo in o3d.geometry.TriangleMesh.create_mobius and in o3d.t.geometry.TriangleMesh.create_mobius: raidus instead of radius as explained in Typo in argument of o3d.geometry.TriangleMesh.create_mobius and in o3d.t.geometry.TriangleMesh.create_mobius #7149
  2. Some typos throughout the docstrings, comments and a string
  3. Proposing a markdown readme for docker on Windows - or should it be part of the docker.in.rst file in order to appear within https://www.open3d.org/docs/latest/docker.html#building-open3d-in-docker?

Checklist:

  • I have run python util/check_style.py --apply to apply Open3D code style
    to my code.
  • This PR changes Open3D behavior or adds new functionality.
    • Both C++ (Doxygen) and Python (Sphinx / Google style) documentation is
      updated accordingly.
    • I have added or updated C++ and / or Python unit tests OR included test
      results
      (e.g. screenshots or numbers) here.
  • I will follow up and update the code if CI fails.
  • For fork PRs, I have selected Allow edits from maintainers.

Description

Copy link

update-docs bot commented Jan 27, 2025

Thanks for submitting this pull request! The maintainers of this repository would appreciate if you could update the CHANGELOG.md based on your changes.

@joseph-sch joseph-sch changed the title Proposed minor improvements: fix arg name in create_mobius, fix typos, add a readme for docker on Windows Fix for #7149 + proposed readme for docker on Windows + fixing typos Jan 27, 2025
@joseph-sch joseph-sch marked this pull request as ready for review January 27, 2025 11:48
Copy link
Contributor

@timohl timohl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good small fixes.

I would mark this PR as breaking change though, since a parameter name changed (with good reason).
It is just a typo fix, but existing calls using named parameters would break.

I cannot say much to the content of the docker windows readme, but there is also docker/README.md where this could be included as a section (or in docs/docker.in.rst as you mentioned.
Not sure if it is a good idea to have 3 different spots documenting docker builds.

@joseph-sch
Copy link
Author

All good small fixes.

I would mark this PR as breaking change though, since a parameter name changed (with good reason). It is just a typo fix, but existing calls using named parameters would break.

I cannot say much to the content of the docker windows readme, but there is also docker/README.md where this could be included as a section (or in docs/docker.in.rst as you mentioned. Not sure if it is a good idea to have 3 different spots documenting docker builds.

Thank you for the feedback

  1. indeed technically it's a breaking change, I've updated the description
  2. I can split the instructions that I proposed between a short mention in docs/docker.in.rst and detailed instructions in docker/README.md - would that be OK?

@timohl
Copy link
Contributor

timohl commented Jan 27, 2025

2. I can split the instructions that I proposed between a short mention in docs/docker.in.rst and detailed instructions in docker/README.md - would that be OK?

Something like that sounds good I think, but somebody else should review that, since I am not using open3d+docker.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typo in argument of o3d.geometry.TriangleMesh.create_mobius and in o3d.t.geometry.TriangleMesh.create_mobius
2 participants