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

Adding parameter description for config files #38

Open
3 of 6 tasks
senagolcuk opened this issue Jul 26, 2022 · 10 comments
Open
3 of 6 tasks

Adding parameter description for config files #38

senagolcuk opened this issue Jul 26, 2022 · 10 comments
Assignees
Labels

Comments

@senagolcuk
Copy link
Contributor

senagolcuk commented Jul 26, 2022

Checklist

  • I've read the contribution guidelines.
  • I've searched other issues and no duplicate issues were found.
  • I've agreed with the maintainers that I can plan this task.

Description

  • Can you add descriptions of parameters in the following yaml files?

  • mirror.param.yaml

  • simulator_model.param.yaml

  • vehicle_info.param.yaml

Purpose

Annotating will make parameters easier to use.

Possible approaches

Add comments for all parameters.

Definition of done

Add comments for all parameters.

@senagolcuk senagolcuk self-assigned this Jul 26, 2022
@takayuki5168
Copy link
Contributor

@senagolcuk
Copy link
Contributor Author

Thank u @takayuki5168. I created PR for two yaml file and releated PR: #39 @xmfcx

@senagolcuk senagolcuk removed their assignment Jul 26, 2022
@stale
Copy link

stale bot commented Sep 25, 2022

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the stale label Sep 25, 2022
@takayuki5168
Copy link
Contributor

@senagolcuk Is it ok to close this issue?

@stale stale bot removed the stale label Sep 26, 2022
@senagolcuk
Copy link
Contributor Author

@takayuki5168 I think there are still unexplained yaml files.

@takayuki5168
Copy link
Contributor

@senagolcuk It's only mirror.param.yaml, right?
I got the information about it. Could you make a PR?
image

As the name suggested, min_height_offset is the min height of mirror, and max_height_offset is the max height of mirror.

@stale
Copy link

stale bot commented Nov 28, 2022

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the stale label Nov 28, 2022
@stale stale bot removed the stale label Nov 29, 2022
@takayuki5168 takayuki5168 self-assigned this Nov 29, 2022
@stale
Copy link

stale bot commented Jan 28, 2023

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the stale label Jan 28, 2023
@senagolcuk
Copy link
Contributor Author

I will check and create PR @takayuki5168 , thanks.

@stale stale bot removed the stale label Jan 30, 2023
@stale
Copy link

stale bot commented Mar 31, 2023

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the stale label Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants