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

improved GCS parameter readablity #23376

Merged
merged 5 commits into from
Aug 19, 2024
Merged

Conversation

Claudio-Chies
Copy link
Contributor

@Claudio-Chies Claudio-Chies commented Jul 9, 2024

The Description for the MPC_POS_MODE Parameters was not clear, as only 0,3, 4 are used, but in the dropdown this was not obvious.
now is clearer what, what is.
image

dagar
dagar previously requested changes Jul 9, 2024
Copy link
Member

@dagar dagar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should be exposing the value of the enums at all. I propose we instead remove the numbering in the long description.

@Claudio-Chies
Copy link
Contributor Author

I don't think we should be exposing the value of the enums at all. I propose we instead remove the numbering in the long description.

The problem there is that the parameter is referenced by the numbers in the docs, so if we move away from the numbers, its even less clear what does what.
another idea would be to remove the numbering in the description, but leave them in the dropdown, especially since numbers are skipped (0,3,4)

@Claudio-Chies Claudio-Chies added the Documentation 📑 Anything improving the documentation of the code / ecosystem label Jul 10, 2024
@dagar
Copy link
Member

dagar commented Jul 11, 2024

I don't think we should be exposing the value of the enums at all. I propose we instead remove the numbering in the long description.

The problem there is that the parameter is referenced by the numbers in the docs, so if we move away from the numbers, its even less clear what does what. another idea would be to remove the numbering in the description, but leave them in the dropdown, especially since numbers are skipped (0,3,4)

Isn't that just more of the same problem? We should only be using the descriptive names everywhere right?

@Claudio-Chies
Copy link
Contributor Author

See PX4/PX4-user_guide#3287
Adapted Feedback and updated Userguide

incoperated feedback

sd
@Claudio-Chies Claudio-Chies dismissed dagar’s stale review August 19, 2024 06:14

changes implemented

@Claudio-Chies Claudio-Chies merged commit 4d21110 into main Aug 19, 2024
96 checks passed
@Claudio-Chies Claudio-Chies deleted the pr-MPC_param_readability branch August 19, 2024 11:36
vertiq-jordan pushed a commit to iq-motion-control/PX4-Autopilot that referenced this pull request Aug 21, 2024
improved GCS parameter description

Co-authored-by: Hamish Willee <[email protected]>
Co-authored-by: Silvan Fuhrer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📑 Anything improving the documentation of the code / ecosystem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants