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

doc: misc. typos #2213

Merged
merged 3 commits into from
Feb 13, 2018
Merged

Conversation

luzpaz
Copy link
Contributor

@luzpaz luzpaz commented Feb 13, 2018

Found via codespell -q 3

Found via `codespell -q 3`
@@ -103,7 +103,7 @@ We are now ready to setup the supervoxel clustering. We use the class :pcl:`Supe

.. important::

By default, the algorithm will use a special tranform compressing the depth in Z if your input cloud is organized (eg, from an RGBD sensor like the Kinect). You MUST set use_transform to false if you are using an organized cloud which doesn't have the camera at (0,0,0) and depth in positive Z. The transform is specifically designed to help improve Kinect data by increasing voxel bin size as distance from the camera increases. If your cloud is unorganized, this transform will not be used by default, but can be enabled by using setUseSingleCameraTransform(true).
By default, the algorithm will use a special transform compressing the depth in Z if your input cloud is organized (eg, from an RGBD sensor like the Kinect). You MUST set use_transform to false if you are using an organized cloud which doesn't have the camera at (0,0,0) and depth in positive Z. The transform is specifically designed to help improve Kinect data by increasing voxel bin size as distance from the camera increases. If your cloud is unorganized, this transform will not be used by default, but can be enabled by using setUseSingleCameraTransform(true).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the changed word here is s/tranform/transform/
(not sure why github does such a poor job of diffing in these cases.)

Copy link
Member

@SergioRAgostinho SergioRAgostinho left a comment

Choose a reason for hiding this comment

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

Thanks. I highlighted two extra places which need tweaking.

@@ -66,7 +66,7 @@ descriptors in the same place, but for different dominant rotations.
The resulting PointCloud contains the type Narf36 (see
common/include/pcl/point_types.h) and store the descriptor as a 36 elements
float and x,y,z,roll,pitch,yaw to describe the local coordinate frame at which
the feature was extracted. The descriptors can now be compared, e.g., whith the
the feature was extracted. The descriptors can now be compared, e.g., with the
Manhatten distance (sum of absolute differences).
Copy link
Member

Choose a reason for hiding this comment

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

Since we're going through doc review, it should actually be Manhattan.

Copy link
Member

Choose a reason for hiding this comment

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

Did you leave this requested change intentionally out?

Copy link
Contributor Author

@luzpaz luzpaz Feb 13, 2018

Choose a reason for hiding this comment

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

Did you leave this requested change intentionally out?

No, not intentionally. I didn't see it on this page for some reason. Will make the change now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@@ -171,7 +171,7 @@ Add the following lines to your CMakeLists.txt file:
Troubleshooting
---------------

Q: I get an error that theres now device connected:
Q: I get an error that there's now device connected:
Copy link
Member

Choose a reason for hiding this comment

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

"there's no"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

makes sense 👍
fixed

@SergioRAgostinho SergioRAgostinho added this to the pcl-1.9.0 milestone Feb 13, 2018
@SergioRAgostinho SergioRAgostinho added the needs: author reply Specify why not closed/merged yet label Feb 13, 2018
@SergioRAgostinho SergioRAgostinho merged commit 7548943 into PointCloudLibrary:master Feb 13, 2018
@SergioRAgostinho
Copy link
Member

Thanks for that :)

@SergioRAgostinho SergioRAgostinho added module: docs and removed needs: author reply Specify why not closed/merged yet labels Feb 13, 2018
@luzpaz luzpaz deleted the doc-misc-typos branch February 13, 2018 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants