8000 Publish generated list of rules on documentation website by per1234 · Pull Request #261 · arduino/arduino-lint · GitHub
[go: up one dir, main page]
Skip to content

Publish generated list of rules on documentation website #261

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Aug 26, 2021
Merged

Publish generated list of rules on documentation website #261

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bed7e04
Avoid workflow conditional reliance on specific runner
per1234 Aug 25, 2021
8096c62
Add multi-module support to project infrastructure
per1234 Aug 25, 2021
ac6f9a3
Add reference URL field to rule configuration
per1234 Aug 23, 2021
453a178
Update reference URLs
per1234 Aug 23, 2021
f532a1a
Add missing rule reference URLs
per1234 Aug 23, 2021
d126e70
Add and expand rule descriptions
per1234 Aug 23, 2021
8aca928
Add test for empty required rule configuration fields
per1234 Aug 24, 2021
13d8760
Publish generated list of rules on documentation website
per1234 Aug 24, 2021
5fc2ed4
Use different syntax style for arbitrary array elements in rule descr…
per1234 Aug 26, 2021
f62a372
Escape Markdown markup in rule reference Brief text
per1234 Aug 26, 2021
fbda05e
Refer to the platform "extra_flags" properties in a less confusing ma…
per1234 Aug 26, 2021
ff3b56a
Use a different term when referring to additional data properties in …
per1234 Aug 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add and expand rule descriptions 
The `Description` field of the rule configuration was previously only used to add supplemental information to the verbose
tool output. In this usage, it did not need to stand on its own as a complete documentation of the rule, and also was not
a high priority since the verbose output is likely not as frequently used.

A new requirement for the rule configuration data has emerged from the project to publish a list of rules. The
`MessageTemplate` data is not suitable for use in this application due to being written for use in indicating a problem
that was found, rather than a documentation of the rule. The new requirement is compatible with the existing use of the
`Description` field, so it is not necessary to add a new field. However, the existing content of the `Description field
is mostly not inadequate, so it must be expanded.

This content is now written in Markdown. Its existing use is limited to the JSON format output. Since the Markdown syntax
is very lightweight and intuitive, and any reader of the JSON format output will already have been presented with plenty
of syntax, I don't think the change has a harmful effect on that output.
  • Loading branch information
@per1234
per1234 committed Aug 26, 2021
commit d126e7058c38618011ea776ec72be4beef40b6d9
Loading
0