Skip to content
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

Merged
merged 1 commit into from
Nov 9, 2021
Merged

Remove en-us from microsoft links, and fix a couple of dead links #1989

merged 1 commit into from
Nov 9, 2021

Conversation

antkmsft
Copy link
Member

@antkmsft antkmsft commented Nov 9, 2021

Closes #1979

@@ -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
Copy link
Member

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?

Copy link
Member

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.

Copy link
Member

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!

Copy link
Member Author

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?

Copy link
Member

@ahsonkhan ahsonkhan left a 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?

@antkmsft
Copy link
Member Author

antkmsft commented Nov 9, 2021

@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 en-us from. Initially I noticed this as I myself put a link with en-us during the Storage SDK development, and decided to see if there are other links like this, and found more.

@ahsonkhan
Copy link
Member

no regexes, manual review

Did you run a Ctrl+F (or find/search in an IDE like VS Code) to capture all instances of links with en-us in the repo?

@antkmsft
Copy link
Member Author

antkmsft commented Nov 9, 2021

@ahsonkhan, Ctrl+Shift+F for "en-us" in VS.

@antkmsft antkmsft added the MQ This issue is part of a "milestone of quality" initiative. label Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IoT MQ This issue is part of a "milestone of quality" initiative.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove en-us from MSDN links
3 participants