API review

Proposer: Tully Foote

Present at review:

  • List reviewers

Question / concerns / comments

Take a look at the auto docs. Are the parameter setting capabilities necessary?

Meeting agenda

To be filled out by proposer based on comments gathered during API review period


Package status change (also mark change on PackageStatusDict page)

  • /!\ Action items that need to be taken.

  • {X} Major issues that need to be resolved

  • /!\ Remove .py extension from executable Python scripts (send_command.py and view_power.py)

  • /!\ Implement SelfTest service (reports that it's happily talking to the power board)

  • /!\ Add more context to documentation (e.g., point out that you must start power_node before using view_power or send_command, both of which call into power_node).

  • /!\ Add screenshot of view_power in action (requires figuring out how to insert images into Doxygen comments; look at player/amcl for an example of doing this)

  • /!\ Rename pr2_power_board to pr2_power_board_panel

  • /!\ Move .fbp and .xrc into a ui subdirectory

Result: API conditionally cleared.

Wiki: pr2_power_board/Reviews/2008-12-11_API_Review (last edited 2009-08-14 20:52:20 by localhost)