-
Notifications
You must be signed in to change notification settings - Fork 22.6k
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
Fix definition lists #19863
Fix definition lists #19863
Conversation
Preview URLs
FlawsNote! 4 documents with no flaws that don't need to be listed. 🎉 URL:
URL:
External URLsURL: No new external URLs URL: No new external URLs URL: No new external URLs URL: No new external URLs URL: No new external URLs URL: No new external URLs (this comment was updated 2022-08-23 07:45:17.800553) |
##### Dummy Test Section | ||
|
||
Testing the Github md lint action. | ||
|
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.
Why should this lead to an MD error (level 5?)?
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.
yeah! [ref]
MD001 - Heading levels should only increment by one level at a time
But it also didn't complain about the trailing spaces on line 33. 😕
Why did the lint succeed? https://github.com/mdn/content/runs/7967730361?check_suite_focus=true
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.
Does it check the branch or the main?
I've committed more spaces. It is working but looks like the linter isn't complaining about two trailing spaces. For one trailing space it did give the annotation.
We've disabled the MD001
in the config file so there is no error for that.
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.
All the trailing spaces have been fixed in:
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.
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.
Note that we don't want this, so it is ok for us to remove them.
So it looks like we have been defensive on which Markdownlint rule to activate. Good! (We can tighten the rules little by little). Let's fix the errors and see how people react to this test. |
Yes, can you open a PR so I can merge it? |
This has been completed in Make lint annotations warnings. |
@@ -54,6 +54,8 @@ let gettingInfo = browser.runtime.getBrowserInfo(); | |||
gettingInfo.then(gotBrowserInfo); | |||
``` | |||
|
|||
{{WebExtExamples}} |
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.
I think this best left in, it would automatically pick up any examples in the web extensions examples repository that use the API
These are the remaining cases in the repo.
Note: Also deliberately added some md errors to test