feat: add parameter description #171
Conversation
Signed-off-by: Takayuki Murooka <takayuki5168@gmail.com>
|
@kenji-miyake |
|
@takayuki5168 Could you write a bit more concrete description? 🙇 |
Signed-off-by: Takayuki Murooka <takayuki5168@gmail.com>
| - `p1`: reference parameter for the node package | ||
| - e.g., [the parameter for the `behavior_path_planner` package](https://github.com/autowarefoundation/autoware.universe/tree/main/planning/behavior_path_planner/config) | ||
| - `p2`: reference parameter for the module launch | ||
| - e.g., [the parameter for the `tier4_planning_launch` package](https://github.com/autowarefoundation/autoware.universe/tree/main/launch/tier4_planning_launch/config/) | ||
| - `p3`: [reference parameter for the `autoware_launch` package](https://github.com/autowarefoundation/autoware_launch/tree/main/autoware_launch/config) |
There was a problem hiding this comment.
How about converting this list to a table?
Also, I feel it's better to use more descriptive names for p1, p2, and p3.
For example, Node Parameter, Component Parameter, and Launch Parameter? 🤔
There was a problem hiding this comment.
Also, is it possible to add a figure to visually explain these types of parameters?
There was a problem hiding this comment.
Thank you for your good idea. I've fixed what I agreed.
The explanation is not short words but sentences, so I feel it better to use itemization rather than the table.
Signed-off-by: Takayuki Murooka <takayuki5168@gmail.com>
Signed-off-by: Takayuki Murooka <takayuki5168@gmail.com>
| - e.g., [the parameter for the `behavior_path_planner` package](https://github.com/autowarefoundation/autoware.universe/tree/main/planning/behavior_path_planner/config) | ||
| - `Component Parameter`: the reference parameter for the component launch | ||
| - e.g., [the parameter for the `tier4_planning_launch` package](https://github.com/autowarefoundation/autoware.universe/tree/main/launch/tier4_planning_launch/config/) | ||
| - `Launch Parameter`: [the reference parameter for the `autoware_launch` package](https://github.com/autowarefoundation/autoware_launch/tree/main/autoware_launch/config) |
There was a problem hiding this comment.
How about replacing the term Launch Paramteter with something like
Autoware ParameterSystem ParameterAutoware_launch Parameter
(Launch Parameter sounds a bit ambiguous to me compared to Node or Component)
There was a problem hiding this comment.
We have a system component, so System Parameter is confusing.
Autoware Parameter may be better?
@kenji-miyake What do you think?
|
@kenji-miyake Can I merge this PR if you get your approval even though the parameter management described in this doc has not been used in autoware. I wrote like this to notice that this is a proposal document for now. |
|
@takayuki5168 Hmm, I think in that case we should discuss and adopt it. What is the blocker for using the parameter management method? |
Signed-off-by: kminoda <koji.m.minoda@gmail.com>
…description first commit
|
(I'm sorry for my late reply.) The development policy is already agreed in autowarefoundation/autoware_launch#66. |
|
This pull request has been automatically marked as stale because it has not had recent activity. |
Signed-off-by: Takayuki Murooka takayuki5168@gmail.com
Related links
autowarefoundation/autoware_launch#66
Description
We will add a config/ directory in the
autoware_launchpackage soon.In this PR, I added the document about what kind of parameters we have and how to manage them.
Pre-review checklist for the PR author
The PR author must check the checkboxes below when creating the PR.
In-review checklist for the PR reviewers
The Reviewers must check the checkboxes below before approval.
Post-review checklist for the PR author
The PR author must check the checkboxes below before merging.
After all checkboxes are checked, anyone who has write access can merge the PR.