Markdown linter (#1309)

* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
This commit is contained in:
Chevdor
2023-09-04 11:02:32 +02:00
committed by GitHub
parent 830fde2a60
commit a30092ab42
271 changed files with 6289 additions and 4450 deletions
+3 -3
View File
@@ -1386,7 +1386,7 @@ fn metadata() {
}
}
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0";
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0\n";
let expected_pallet_doc = vec![" Pallet documentation", readme, readme];
let pallets = vec![
@@ -1889,7 +1889,7 @@ fn metadata_ir_pallet_runtime_docs() {
.find(|pallet| pallet.name == "Example")
.expect("Pallet should be present");
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0";
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0\n";
let expected = vec![" Pallet documentation", readme, readme];
assert_eq!(pallet.docs, expected);
}
@@ -1919,7 +1919,7 @@ fn extrinsic_metadata_ir_types() {
#[test]
fn test_pallet_runtime_docs() {
let docs = crate::pallet::Pallet::<Runtime>::pallet_documentation_metadata();
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0";
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0\n";
let expected = vec![" Pallet documentation", readme, readme];
assert_eq!(docs, expected);
}