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

Some variable names are unclear #87

Open
rokusottervanger opened this issue Feb 23, 2022 · 1 comment
Open

Some variable names are unclear #87

rokusottervanger opened this issue Feb 23, 2022 · 1 comment
Labels
refactor Refactor request

Comments

@rokusottervanger
Copy link
Contributor

rokusottervanger commented Feb 23, 2022

There is a number of variables that represent dimensions and quantities that are referenced in the explanation of the control strategy in the README. Naming of these variables is not consistent, though. Some variables are just unclear in what they represent from their names. This holds for (but is not limited to):

  • l: the lookahead distance (not mentioned as such in the README yet)
  • current_tf
  • some of the controller state members, such as current_x_vel (which is the setpoint, I suppose)
This was referenced Feb 23, 2022
@Timple
Copy link
Member

Timple commented Feb 24, 2022

Some variable names are also present in the pictures in the README.md.

I propose to name them according to the pictures.

@lewie-donckers lewie-donckers added the refactor Refactor request label Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Refactor request
Projects
None yet
Development

No branches or pull requests

3 participants