PointCloudLibrary / PointCloudLibrary/pcl

inconsistent data member naming convention in pcl::PointCloud

Open
#2,469 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

module: common needs: feedback
Dominant language
C++
Stars
11.1k
Forks
4.7k
Avg merge
4d 10h
Merged PRs (30d)
6

Description

Your Environment

  • PCL Version: the master branch

Context

See the code
https://github.com/PointCloudLibrary/pcl/blob/9467b944ee3e30bb4cf8445d861c280f0fba1020/common/include/pcl/point_cloud.h#L413-L423

https://github.com/PointCloudLibrary/pcl/blob/9467b944ee3e30bb4cf8445d861c280f0fba1020/common/include/pcl/point_cloud.h#L592

Some data members are ended with _ and some are not.

Expected Behavior

Either all end with _ or none.

Current Behavior

The naming convention is not consistent.

Code to Reproduce

See the code above.

Possible Solution

Rename the data members consistently.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read common/include/pcl/point_cloud.h at the referenced lines around the data members and inspect the surrounding naming conventions. Determine the consistent convention and identify the affected members and their usages; done means the relevant pcl::PointCloud data members follow one convention without breaking their existing interfaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
computer-vision
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.