-
-
Notifications
You must be signed in to change notification settings - Fork 410
Make the configuration documentation in a table. #2907
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
Make the configuration documentation in a table. #2907
Conversation
So that default is displayed, but on Windows and MacOS, there's a missing default and there are values that dont have a default ?
Sorry for the second PR, I just did not know how to fix the other one (#2906 ) , but it still have mysterious errors. Possibly cause I used |
I should have put the variable section (board_manager, daemon, directories, ...) as part of the variable names, the table would have been easier to read and get rid of the |
We use a tool named Prettier to format the markdown documents with a consistent style: https://arduino.github.io/arduino-cli/1.2/CONTRIBUTING/#docs-formatting You should run this tool on the files you edited before submitting. In your case, the table does not have the vertical bars aligned, which is one of Prettier's automatically enforced styles. You don't need to open another PR, just make another commit and push, it will update the PR and re-run the checks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your proposal @kristianbenoit! After some consideration, I decided that the current nested list format is the most appropriate for this information.
I noticed that, as part of this pull request, you had done some work towards documenting the true default for build_cache.path
. I have carried that work forward in #2919
@per1234, the reason I used table is to have a column for default value separated from the doc. You probably noticed In the previous commit, I tried to keep the indentation, but I made another commit, trying to fix the "prettier" error, removing the indentation. I also added a few things in that second commit. I guess I should add what I've done to the current format, but where should I systematically add the default values ? In parentheses after the doc string ? |
So that default is displayed, but on Windows and MacOS, there's a missing default and there are values that dont have a default ?
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.md
has been updated with a migration guide (for breaking changes)configuration.schema.json
updated if new parameters are added.What kind of change does this PR introduce?
Documentation get's a better format.
What is the current behavior?
The defaults are not really available in the doc and it is a bit hard to understand, plus the directories seems to be there twice.
What is the new behavior?
Documentation is now a table with default values, it should be reviewed to add a few defaults (in code) and the value for
buld_cache.path
on Windows an MacOS in this doc.Does this PR introduce a breaking change, and is titled accordingly?
Other information
Sorry, this a pull request replacing #2906 . Which had errors and I fixed bypassed them by creating another pull request after the last changes.