Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Mar 5, 2023

Conversation

pavel-kirienko
Copy link
Member


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

@pavel-kirienko pavel-kirienko self-assigned this Mar 4, 2023
@asmfreak asmfreak marked this pull request as ready for review March 4, 2023 21:16
@asmfreak
Copy link
Contributor

asmfreak commented Mar 4, 2023

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
Copy link
Member Author

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.

This commit also removes two filters: definition_begin and definition_end.
This is because the new logic makes them not easy to reuse.
@pavel-kirienko pavel-kirienko requested review from asmfreak and thirtytwobits and removed request for asmfreak March 4, 2023 22:37
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 4, 2023

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

Copy link
Contributor

@asmfreak asmfreak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My initial comment wasn't sarcasm. I liked the feature so much, that I came running to push the approve pr button and changed the draft status instead. I approve.

@pavel-kirienko pavel-kirienko merged commit 9dafc1c into main Mar 5, 2023
@pavel-kirienko pavel-kirienko deleted the cpp branch March 5, 2023 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants