-
Notifications
You must be signed in to change notification settings - Fork 121
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
Remove en-us
from microsoft links, and fix a couple of dead links
#1989
Conversation
@@ -51,7 +51,7 @@ az_precondition_failed_fn az_precondition_failed_get_callback(); | |||
// earlier without verifying, because if __analysis_assume() is not available on earlier compiler | |||
// version, there will be a compilation error. | |||
// For more info, see | |||
// https://docs.microsoft.com/en-us/windows-hardware/drivers/devtest/using-the--analysis-assume-function-to-suppress-false-defects |
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 was going to ask why link verification didn't catch this, but guessing that since these are just links within doc comments, not an actual hyperlink within markdown or other such docs, it doesn't get validated.
@danieljurek, @weshaggard has this come up as a way to improve link verification in other languages? If we have typos in links within source code comments that could 404, should those be verified?
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.
You are correct that we don't validate random links in any text we only look at well formed links in MD or html. This has come up in .NET XML doc comments recently, Azure/azure-sdk-for-net#22216, although we don't have a solution for that currently either. It can be tricky to parse out links in random source code.
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.
That's what I figured. Thanks!
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.
#1980 Is about this, but based on @weshaggard's response, I think we can close it?
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.
How did you initially notice these @antkmsft ?
And did you run some regex to find/fix them all?
@ahsonkhan, no regexes, manual review. There weren't that many to review manually. Dead links I've found as I was still verifying each link I was removing |
Did you run a Ctrl+F (or find/search in an IDE like VS Code) to capture all instances of links with |
@ahsonkhan, Ctrl+Shift+F for "en-us" in VS. |
Closes #1979