OpenCyphal / nunavut

Generate code from DSDL using PyDSDL and Jinja2
https://nunavut.readthedocs.io/
Other
39 stars 24 forks source link

C++: Fix incorrect handling of blank lines in doc comments; fix a minor mistake introduced in the prior PR #290

Closed pavel-kirienko closed 1 year ago

pavel-kirienko commented 1 year ago

I find the naming of the service pseudo-type Service_{{major}}_{{minor}} non-obvious and I would like to suggest renaming it such that the service pseudo-type is named after the service itself suffixed with the version numbers. This would be in line with the way it is implemented in Python. Instead of this:

uavcan::_register::Access::Request_1_0
uavcan::_register::Access::Response_1_0
uavcan::_register::Access::Service_1_0

We would have this:

uavcan::_register::Access::Request_1_0
uavcan::_register::Access::Response_1_0
uavcan::_register::Access_1_0

Then there already are aliases inside Access_1_0 which means that the full set of the available names is as follows:

uavcan::_register::Access::Request_1_0
uavcan::_register::Access::Response_1_0
uavcan::_register::Access_1_0
uavcan::_register::Access_1_0::Request
uavcan::_register::Access_1_0::Response

See related discussion in #155 and #190

asmfreak commented 1 year ago

I'm sorry, if I've pulled the draft status too soon, I just wanted to say, that this is a great simplification! I like this a lot!

pavel-kirienko commented 1 year ago

I like this a lot!

Is this sarcasm or do you really support the proposal? Anyway, I think I am going to implement it now; shall Scott be against it, it can be reverted later.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication