Public APIs and overall API design needs to be documented

ros-industrial-consortium / packml

ROS packml (https://en.wikipedia.org/wiki/PackML) support package

Apache License 2.0

9 stars 14 forks source link

Public APIs and overall API design needs to be documented #36

Open shaun-edwards opened 6 years ago

shaun-edwards commented 6 years ago

The documentation of the packml library is non-existent. It would get more/broader use if the APIs were documented. Changes made in https://github.com/ros-industrial-consortium/packml/pull/35 introduce a new dependency and new concepts (although still under a very similar interface/API).