Skip to content

Improve Parameter Metadata display in QGC#20125

Closed
junwoo091400 wants to merge 1 commit intoPX4:mainfrom
junwoo091400:pr_param_desc_parse_improvement
Closed

Improve Parameter Metadata display in QGC#20125
junwoo091400 wants to merge 1 commit intoPX4:mainfrom
junwoo091400:pr_param_desc_parse_improvement

Conversation

@junwoo091400
Copy link
Copy Markdown
Contributor

@junwoo091400 junwoo091400 commented Aug 29, 2022

Describe problem solved by this pull request

Currently the Parameter metadata are badly formatted in QGC, which makes the QGC user experience unpleasant. The goal is to have a beautiful / clearly formatted description for parameters that is separated with new-line characters as documented in the source code itself.

image

The QGC Issue that describes related issues: mavlink/qgroundcontrol#10382

Describe your solution

Change the Parameter metadata parser script to parse the description part properly by not removing the newline characters, so that QGC would display exactly the same line endings.

For this, I am planning to incorporate parser as following:

  1. Consider two consecutive lines without empty line (as a comment) in between separated by a 'space'
  2. Consider the empty line between the paragraph for the 'long description' as a valid newline

@bkueng
Copy link
Copy Markdown
Member

bkueng commented Aug 31, 2022

Good intent, but I don't think it's worth changing the old parser as we move to yaml. There we already have better formatting options.

@junwoo091400
Copy link
Copy Markdown
Contributor Author

Good intent, but I don't think it's worth changing the old parser as we move to yaml. There we already have better formatting options.

Yep good point, the YAML options sounds way better! I will then continue in a better YAML PR.

  1. By the way where are those formatting stuff documented? Maybe then I can start porting the .c parameter files to .yaml for ones with long descriptions
  2. Can I have both .c parameter & .yaml at the same time? (Out of curiosity)

@bkueng
Copy link
Copy Markdown
Member

bkueng commented Aug 31, 2022

@coderkalyan almost finished all of the transition in #19489

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants