WindowsCommunityToolkit icon indicating copy to clipboard operation
WindowsCommunityToolkit copied to clipboard

Links in XML comments need updating

Open michael-hawker opened this issue 3 years ago • 5 comments

Describe the bug

We need to update our XML comments to have better standards for when they're generated into docs:

  • [ ] ideally use a typed reference vs. a specific url link
  • [ ] use https instead of http
  • [ ] not include locale like en-us in the link url
  • [ ] don't link to specific views with query-strings to docs

michael-hawker avatar Mar 11 '21 00:03 michael-hawker

Hello,I wants to work n this issue. can you tell me what to do in this issue?

sahilrawat001 avatar Jul 02 '21 19:07 sahilrawat001

Hi @sahilrawat001, sorry we missed your comment. Let us know if you're still interested in lending a hand.

This issue is about cleaning up our XML comments, so for instance this one:

https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/63cbb4a51bdef59083ccfc86bbcba41f966d0027/Microsoft.Toolkit.Uwp.UI.Media/Brushes/RadialGradientBrushInterop.cs#L18-L24

It has both a link still using 'http' instead of 'https' on the 2nd one, and the first has 'en-us' in it which should just be removed so that the docs page can redirect to the user's locale if available. i.e. https://msdn.microsoft.com/library/system.windows.media.colorinterpolationmode(v=vs.110).aspx In this case too since this is an older msdn link and redirect, we may just want to update to be: https://docs.microsoft.com/dotnet/api/system.windows.media.colorinterpolationmode directly.

Here's another http case:

https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/63cbb4a51bdef59083ccfc86bbcba41f966d0027/Microsoft.Toolkit.HighPerformance/Extensions/ReadOnlySpanExtensions.cs#L351

michael-hawker avatar Oct 07 '21 23:10 michael-hawker

Hi, If the issue is still open and no one is working on it then I'm willing to cover that. It will be a good one for my first contribution here ;-) Please assign it to me

tutkus avatar Apr 24 '22 16:04 tutkus

Thanks @tutkus, that's great to know! We're going to be in the progress of some migrations in the near future (see the discussion in #4486). It'd probably be best to tackle these types of wide-spread changes after our initial refactoring/migration work (to make sure they don't get lost or create troubles for merging branches). Want me to reach out once we've gotten to a good point with that in a couple months?

In the meantime, I replied to the converter issue you expressed interest in. Let us know if you have any questions.

michael-hawker avatar Apr 25 '22 23:04 michael-hawker

@michael-hawker, all good. pls let me know once you get the source code to the shape which allows to move farther with this issue. I can work on it. In the meantime if you have sth else which I could pick up (apart of the one already assigned to me), fell free to assign to me as well (very willing to help).

tutkus avatar Apr 26 '22 06:04 tutkus