search

uf-mil / mil

Monorepo of the Machine Intelligence Lab at the University of Florida
https://mil.ufl.edu/docs
Other
44 stars 29 forks source link

Add support for multi-language signatures in RTD #508

Open cbrxyz opened 2 years ago

cbrxyz commented 2 years ago

Add support for signatures in multiple languages, such as having a signature compatible with Python and C++. This would help developers move between the languages.

This support could initially be included for custom classes, such as message or service types. For example, the Alarm message type should have a signature supporting ros_alarms.msg._Alarm.Alarm and ros_alarms::Alarm.

cbrxyz commented 2 years ago

Multiple signatures aren't supported between multiple languages because this generally isn't allowed by a compiler. Rather, each class in each language gets its own docstring.

cbrxyz commented 2 years ago

Reopening because this could be helpful for documenting message types.