-
Notifications
You must be signed in to change notification settings - Fork 6k
Migration: docs/framework/additional-apis/index #1880
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
Migration: docs/framework/additional-apis/index #1880
Conversation
The .NET Framework is constantly evolving and in order to improve cross-platform development or to introduce new functionality early to our customers, we release new features out of band (OOB). This topic lists the OOB projects that we provide documentation for. | ||
|
||
In addition, some libraries target specific platforms or implementations of the .NET Framework. For example, the | ||
[CodePagesEncodingProvider Class](CodePagesEncodingProvider.xml) class makes code page encodings available to UWP apps developed using the .NET Framework. This topic lists these libraries as well. | ||
In addition, some libraries target specific platforms or implementations of the .NET Framework. For example, the [CodePagesEncodingProvider Class](https://msdn.microsoft.com/library/system.text.codepagesencodingprovider.aspx) class makes code page encodings available to UWP apps developed using the .NET Framework. This topic lists these libraries as well. |
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.
We've duplicated class here (Class and class). Best to leave "Class" out of the link text.
|<xref:System.Text.CodePagesEncodingProvider>|Extends the <xref:System.Text.EncodingProvider> class to make code page encodings available to apps that target the Universal Windows Platform.| | ||
| Project | Description | | ||
| ------- | ----------- | | ||
| [System.Text.CodePagesEncodingProvider](https://msdn.microsoft.com/library/system.text.codepagesencodingprovider.aspx) | Extends the <xref:System.Text.EncodingProvider> class to make code page encodings available to apps that target the Universal Windows Platform. | |
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.
Code pages encoding provider exists in the API Browser, so it should be renderable as a link. Did xref:System.Text.CodePagesEncodingProvider not resolve?
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 didn't resolve the first time. I'll double-check and confirm it works/breaks.
| ------- | ----------- | | ||
| [System.Collections.Immutable](https://msdn.microsoft.com/library/system.collections.immutable.aspx) | Provides collections that are thread safe and guaranteed to never change their contents. | | ||
| [System.Net.Http.WinHttpHandler](http://go.microsoft.com/fwlink/p/?LinkId=624833) | Provides a message handler for <xref:System.Net.Http.HttpClient> based on the WinHTTP interface of Windows. | | ||
| <xref:System.Numerics> | Provides a library of vector types that can take advantage of SIMD hardware-based acceleration.| |
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.
The problem here is that we have to link to the .NET Core package rather than a general one. I think that we need to do this as System.Numerics.Vectors.
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 see it ... https://docs.microsoft.com/en-us/dotnet/api/system.numerics.vector?view=netcore-1.1.0
I'll try again. I thought it failed the first time, but I may have been trying to link it as System.Numerics.Vectors%601
.
--> | ||
| Project | Description | | ||
| ------- | ----------- | | ||
| [System.Collections.Immutable](https://msdn.microsoft.com/library/system.collections.immutable.aspx) | Provides collections that are thread safe and guaranteed to never change their contents. | |
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.
My internet connection is down, but this should exist as a NuGet package that's part of .NET Core. So it should exist on docs.
@rpetrusha If that Vector class destination is good, I think we're ok now with this one. |
| Project | Description | | ||
| ------- | ----------- | | ||
| <xref:System.Collections.Immutable> | Provides collections that are thread safe and guaranteed to never change their contents. | | ||
| [System.Net.Http.WinHttpHandler](http://go.microsoft.com/fwlink/p/?LinkId=624833) | Provides a message handler for <xref:System.Net.Http.HttpClient> based on the WinHTTP interface of Windows. | |
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.
Rather than an fwlink, this should link to WinHttpHandler on docs. If xref:System.Net.Http.WinHttpHandler doesn't work, it's found in ../../xml/System.Net.Http/WinHttpHandler.xml.
| <xref:System.Collections.Immutable> | Provides collections that are thread safe and guaranteed to never change their contents. | | ||
| [System.Net.Http.WinHttpHandler](http://go.microsoft.com/fwlink/p/?LinkId=624833) | Provides a message handler for <xref:System.Net.Http.HttpClient> based on the WinHTTP interface of Windows. | | ||
| <xref:System.Numerics.Vector> | Provides a library of vector types that can take advantage of SIMD hardware-based acceleration.| | ||
| [TPL Dataflow Library](../../../docs/standard/parallel-programming/dataflow-task-parallel-library.md) | The TPL Dataflow Library provides dataflow components to help increase the robustness of concurrency-enabled applications. | |
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.
This isn't a link to the API reference. Try xref:System.Threading.Tasks.Dataflow. The dataflow library is in GitHub.
| ------- | ----------- | | ||
| <xref:System.Collections.Immutable> | Provides collections that are thread safe and guaranteed to never change their contents. | | ||
| [System.Net.Http.WinHttpHandler](http://go.microsoft.com/fwlink/p/?LinkId=624833) | Provides a message handler for <xref:System.Net.Http.HttpClient> based on the WinHTTP interface of Windows. | | ||
| <xref:System.Numerics.Vector> | Provides a library of vector types that can take advantage of SIMD hardware-based acceleration.| |
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.
This isn't correct, Vector is a single type, not the set of types found in the OOB NuGet package.
I had thought we just needed to link to the System.Numerics namespace with the .NET Core filter set, but that includes BigInteger, which isn't part of the OOB release. Unfortunately, I can't think of a solution to this issue other than linking to the MSDN page, which is what you'd done originally. We'd need new feature work done to support specific OOB packages.
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.
Either https://msdn.microsoft.com/library/mt452176.aspx or https://msdn.microsoft.com/en-us/library/mt598257(v=vs.111).aspx, The first one is preferable, I think.
@rpetrusha ... ok, this one is ready for review+merge.