Clearly mark classes that are not part of YARP public API #1518
traversaro
started this conversation in
General
Replies: 1 comment
-
|
As usual this is more a remainder and a way for this idea to get exposed to the wider YARP community, but it would be a good idea to briefly discuss about this f2f. @drdanz @randaz81 |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The YARP project has a strict (in theory) policy on how to properly deprecate methods, documented in https://github.com/robotology/yarp/blob/master/.github/CONTRIBUTING.md#deprecated-features .
From time to time we find that (for historical reason) there are several classes exposed in the installed headers of YARP that should not and are not used by downstream projects. For this classes (see for example #1517 ) the deprecation rules can be less strict. However we should properly document and mark the classes/functions that are not actually part of YARP public API, and for which the deprecation policy does not applies.
Beta Was this translation helpful? Give feedback.
All reactions