-
Notifications
You must be signed in to change notification settings - Fork 51
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
docs: add parameter tables generated from schemas per vendor and sensor model #195
Conversation
1a0a217
to
1b2b963
Compare
6bf270a
to
cd3efd2
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## develop #195 +/- ##
=========================================
Coverage ? 0.00%
=========================================
Files ? 34
Lines ? 3605
Branches ? 0
=========================================
Hits ? 0
Misses ? 3605
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
…in navigation (tier4#194) * docs: add API reference page and add things like class references to nav * Apply suggestions from code review Co-authored-by: David Wong <33114676+drwnz@users.noreply.github.com> * docs: fix case style of API reference heading Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> --------- Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> Co-authored-by: David Wong <33114676+drwnz@users.noreply.github.com>
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.
Mostly looks great, some minor suggested changes.
The only other thing that I noticed, was that generally parameter tables are built from the schema except for Hesai common which has extra (very detailed) explanation.
It might be more consistent to generate Hesai common the same as the others and add an explanation below the parameter table. This could also be done for the Nebula common parameters as well.
…odel in the current schema file
…ns an about section
Co-authored-by: David Wong <33114676+drwnz@users.noreply.github.com>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
7efc2bd
to
a6ad7cd
Compare
The Hesai table I can do. For the common one, there is almost no overlap between all sensors, so I would have to create around 3 separate schemas to cover everything (e..g CAN vs. IP, scan_phase vs cut angle etc.). I don't think it would be a particularly nice solution. |
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
I added the Hesai table, please check @drwnz 🙏 |
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.
LGTM, nice :)
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
PR Type
Description
This PR adds
Review Procedure
Render the docs and confirm the tables are complete and correct.
Pre-Review Checklist for the PR Author
PR Author should check the checkboxes below when creating the PR.
Checklist for the PR Reviewer
Reviewers should check the checkboxes below before approval.
Post-Review Checklist for the PR Author
PR Author should check the checkboxes below before merging.
CI Checks