-
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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
Update documentation to be coherent with the style guide #4771
Update documentation to be coherent with the style guide #4771
Conversation
Update include guard to #pragma once, fix link to style guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might have to see visually to verify, but that's after merge
@@ -1175,8 +1154,7 @@ And the *bilateral.hpp* likes: | |||
* | |||
*/ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we could use this PR to update also the LICENSE blurb to use the new one when writing a class. What do you think @kunaltyagi ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blurb in this rst file? Sure. But not in actual code files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, speaking about the doc, not actual code!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one? Maybe we should also add this to the style guide in a new PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be considered a style guide? Isn't that more for code? We do have a blurb in contributing.md for reference
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I would consider it as style guide (Google Style Guide also include in their guide)
But maybe updating this file is enough for new contributors, as anyone wanted to implement a new class will definitely look at this rst
also I found the links to the class are also broken (e.g. `:pcl: but I'm not sure if it's correct as I didn't use doxylink before |
Paging @larshg for assist in doxylink |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This changeset looks self-contained. Please use other PRs for doxylink corrections or other improvements :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
I'm not familiar with doxylink or the like, sorry. |
#pragma once
The include guard
bilateral.hpp
is still in the old style, I will update it when I refactor other filters later