search

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.56k stars 2.78k forks source link

Broken link to example #19991

Closed Goldensunboy closed 3 years ago

Goldensunboy commented 3 years ago

The page says "Here is an example for using POST with an Analytics query" but the link is broken.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

rakshith91 commented 3 years ago

Thanks for the issue!! we'll look into it asap

Goldensunboy commented 3 years ago

It seems there are several pages with links that do not work in this documentation, and they all appear to have something weird going on with the URL. It looks like multiple full "https" URLs all jammed into one.

scbedd commented 3 years ago

@Goldensunboy Yep. Looks like the package owners didn't realize that markdown links and sphinx links were not formatted the same way. Check it out rendering oddly in our sphinx github.io docs too.

I'm working up a PR to adjust all the instances I can find. I'd need to talk to the real owners to understand if they think it's worth releasing a new version of the package, but we'll figure it out.

Thanks!

scbedd commented 3 years ago

Hey @Goldensunboy ,

I submitted a PR over here that addresses the wonky links. I did do a quick search to find more examples, but only tracked down one other. You mind pointing me at the

It looks like multiple full "https" URLs all jammed into one.

you're talking about?

Goldensunboy commented 3 years ago

On the same page: "The Analytics query. Learn more about the Analytics query syntax" (broken link)

On this page there appears to be a missing link to the field "config" of type ApplicationInsightsDataClientConfiguration

scbedd commented 3 years ago

On the same page: "The Analytics query. Learn more about the Analytics query syntax" (broken link)

Ok awesome I already got that one in my PR.

On this page there appears to be a missing link to the field "config" of type ApplicationInsightsDataClientConfiguration

👍 Known issue. Currently waiting on the docs.ms crew to ship their new generator. Any missing params or params mislabeled with required will be fixed by that update.