Use log_param_doc.json from crazyflie-firmware #521
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If resources/log_param_doc.json file is present use it to provide descriptions to log- and param groups and variables.
This workflow will clone the crazyflie-firmwre, generate a JSON file with documentation of log- and param groups and variables and then commit and push that as src/cfclient/resources/log_param_doc.json.
jonasdn
requested review from
ataffanel,
Bananazooka,
evoggy,
knmcguire,
krichardsson and
tobbeanton
|
I think it's a great idea, and it seems to all check out, but probably @ataffanel should take a look at it as well! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes use of the logging and parameter documentation in the
crazyflie-firmwarerepository to generate descriptions for the log- param tabs.If, and only if, the file
src/cfclient/resources/log_param_doc.jsonis present, we will use it to display descriptions for logging- and parameter groups and parameters in the relevant tabs.This PR also adds a GitHub actions workflow to generate and update the JSON file each night.
Commits: