Request code comments for calibration_service.cpp about industrial_calibration

[gavanderhoorn]

Could you elaborate a bit? Is there a pull request to be reviewed?

[shaun-edwards]

The code in calibration_service.cpp is quite long. The proper place for comments for node level functionality is the ros wiki. We are also reworking the calibration code to be more self-contained and documented at a library level (i.e. in doxygen). This would result in a very thin wrapper node, which should require very little commenting. As a rule documentation should be done in the header file and on the wiki. Redundant documentation should be avoided because it will inevitably go out of sync. As far as comments in source files, it is far better to write code that reads well (i.e. self documents without comments). Comments in source files should be very limited.

[phvass]

OK. Rescinded.

[shaun-edwards]

@phvass . I'm going to keep it open because it's a good point. Often times the fix for the issue is not was initially proposed. The reason for the issue, that calibration_service is hard to follow, is still valid and should be addressed. We will just do so in a different way.

Thanks for submitting, and please feel free to keep doing so.

[drchrislewis]

the calibration_service.cpp code looks like a thin ros wrapper to me