Updates to empty namespace docs #5055
Conversation
|
|
|
Docs Build status updates of commit 0dee100: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
| @@ -1,6 +1,6 @@ | |||
| <Namespace Name="System.Runtime.Intrinsics.Arm"> | |||
| <Docs> | |||
| <summary>To be added.</summary> | |||
| <summary>Contains classes representing the different SIMD instruction sets available to the ARM architecture. Not all of these instructions sets are available on all ARM CPUs though. Check the "IsSupported" property on each class to determine compatibility with the executing CPU.</summary> | |||
There was a problem hiding this comment.
This, and the same for x86, could likely be reworded slightly. The underlying APIs largely touch SIMD code, but there are also other APIs which aren't SIMD at all.
Perhaps this could say something like:
Exposes select instructions available on ARM (branding needed?) hardware. These instructions are divided into separate classes representing the underlying ISAs (Instruction Set Architectures) exposed by the platform. Support for an ISA can be queried via the
IsSupportedproperty exposed on the respective type and may be false if the underlying hardware does not support it or if it is not currently supported by the underlying runtime.
There was a problem hiding this comment.
Some of this feels more like conceptual docs however and it is a bit more wordy than most summaries.
There was a problem hiding this comment.
I agree. I reworded it, mixing your phrasing with mine. The revised phrasing is able to drop the comment about IsSupported if you deem it too wordy still.
| @@ -1,6 +1,6 @@ | |||
| <Namespace Name="System.Runtime.Intrinsics.X86"> | |||
| <Docs> | |||
| <summary>To be added.</summary> | |||
| <summary>Contains classes representing the different SIMD instruction sets available to the x86 architecture. Not all of these instructions sets are available on all x86 CPUs though. Check the "IsSupported" property on each class to determine compatibility with the executing CPU.</summary> | |||
There was a problem hiding this comment.
Not sure if it's worth clarifying that x86 includes x64 in this context.
There was a problem hiding this comment.
I added x64 in my latest commit.
|
Docs Build status updates of commit 68024aa: 🕙 Pending: waiting for processors (33 builds ahead of you) |
|
Docs Build status updates of commit 68024aa: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
Docs Build status updates of commit aa004fe: 🕙 Pending: waiting for processors (40 builds ahead of you) |
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
Docs Build status updates of commit 472169e: 🕙 Pending: waiting for processors (40 builds ahead of you) |
|
Docs Build status updates of commit c07a8da: 🕙 Pending: waiting for processors (40 builds ahead of you) |
|
Docs Build status updates of commit aa004fe: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 9ac291c: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 9ac291c: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Summary
Added summaries to the following:
System.Runtime.IntrinsicsSystem.Runtime.Intrinsics.X86System.Runtime.Intrinsics.Arm