Skip to content

Conversation

@carsten-kuebler
Copy link
Contributor

Remove doxygen windows bug (roadmarking types are not correct).
Add StVO road markings as symbolic signs in documentation of traffic signs (resolves #229 and resolves #230 and additional road markings).

Remove doxygen windows bug (roadmarking types are not correct).
Add StVO road markings as symbolic signs in documentation of traffic signs.
@carsten-kuebler carsten-kuebler added the Documentation Everything which impacts the quality of the documentation and guidelines. label May 2, 2018
@carsten-kuebler carsten-kuebler added this to the v3.0.1 milestone May 2, 2018
@carsten-kuebler carsten-kuebler self-assigned this May 2, 2018
@carsten-kuebler carsten-kuebler requested a review from a user May 2, 2018 13:09
Add StVO no for symbolic traffic signs as road markings
// (StVO 211.1). Right: #TYPE_PRESCRIBED_RIGHT_WAY
//
// (StVO 211.1). Right: \c #TYPE_PRESCRIBED_RIGHT_WAY
//
Copy link

Choose a reason for hiding this comment

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

Do we have a test checking for spaces before line break?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No. I created unit tests mainly for errors. The space at the end of a line is more of an unwanted character and rather reduces the file size. A space at the end of a line doesn't cause an error, does it? Of course, it is very easy to add such an unit test. I suspect that every initial checkin will lead to an error with this unit test. Do we want to set up these high barriers for a check-in at GitHub?

I personally support unit tests. Should we add this unit test?

Copy link

Choose a reason for hiding this comment

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

Could you check for automatic style guide testing more in general? https://clang.llvm.org/docs/ClangFormat.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

clang-format works for proto files, clang-check doesn't work for proto files (c,c++ works fine). We could use clang-format to reformat the files. Should we add active code-modification and github checkin via travis ci?

Copy link

Choose a reason for hiding this comment

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

yes, do we need a TravisCI user for that? The commit should be on the branch of the PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. We can use the same mechanism as for the auto-documentation. Drawback: We could end in an infinite loop 8-) of auto-check-ins.

@ghost ghost merged commit c504e32 into master May 3, 2018
@ghost ghost deleted the documentation/v3.0.1-update-10 branch May 3, 2018 08:56
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Everything which impacts the quality of the documentation and guidelines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Sign 294 "stopping line" in Documentation Add Sign 297 "direction arrows" in documentation

3 participants