drivers: can: clarify the meaning of minimum/maximum supported bitrates #80127
Conversation
|
I see commit body contains repetition but this is negligible. |
Clarify the meaning of of minimum/maximum supported bitrates in the CAN controller driver API. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
henrikbrixandersen
force-pushed
the
can_get_bitrate_min_doxygen
branch
from
ee65755 to
dfbc070
Compare
Thanks, fixed. |
| * | ||
| * @deprecated Use @a can_get_bitrate_min() instead. | ||
| * | ||
| * @note The minimum bitrate represents limitations of the CAN controller/transceiver |
There was a problem hiding this comment.
It's laudable to update the docs for the deprecated function -- it really is! -- but in this instance I wonder if it's not counter productive. Keeping the docs of the deprecated method as lean as possible helps make the @deprecated mention less buried in surrounding text.
I think it's acceptable to let the docs of a deprecated method go stale since, after all, any new user is encouraged to look for the replacement. And to some extent I think it's ok that any existing user in need to look back at the docs to understand/clarify the behavior would basically see the docs as they were when it was decided to deprecate the method.
There was a problem hiding this comment.
Thank you for reviewing. I opted to keep the documentation in sync between the deprecated functions and their replacement to convey that there are no functional changes between the two.
7 participants
Clarify the meaning of the meaning of minimum/maximum supported CAN bitrates.