Added ThrowHelper APIs docs page #370
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
|
Docs Build status updates of commit 73ab579: 🕙 Full build: the average full build time is 5 min(s) 36 sec(s), this is based on the last 19 build(s) for this repository. |
john-h-k
suggested changes
Jul 21, 2020
docs/developer-tools/ThrowHelper.md
Outdated
|
|
||
| There are lots of different methods and overloads in the `ThrowHelper` class, providing access to the following exceptions (and mapping all their public constructors): | ||
|
|
||
| - [ArrayTypeMismatchException](https://docs.microsoft.com/dotnet/api/system.ArrayTypeMismatchException) |
There was a problem hiding this comment.
Applications shouldn't throw ArrayTypeMismatchException ever. They should throw ArgumentException
There was a problem hiding this comment.
I checked the docs but I couldn't actually find a line explicitly saying this shouldn't ever be thrown by user code (eg. like OutOfMemoryException). I thought this could still be useful in some cases, eg. in libraries that are implementing some custom array/span-like data structure (like we're doing in the new Memory2D<T> APIs, which do throw this exception in some cases to be consistent with the original Memory<T> APIs 🤔
Thoughts?
|
^ for future ref, this would be a suitable attribute to apply here |
|
Docs Build status updates of commit c0e621e: 🕙 Full build: the average full build time is 5 min(s) 36 sec(s), this is based on the last 19 build(s) for this repository. |
|
Docs Build status updates of commit 4b1c607: 🕙 Full build: the average full build time is 5 min(s) 36 sec(s), this is based on the last 19 build(s) for this repository. |
michael-hawker
requested changes
Jul 21, 2020
|
Docs Build status updates of commit dc598de: 🕙 Full build: the average full build time is 5 min(s) 36 sec(s), this is based on the last 19 build(s) for this repository. |
|
Re-opening to trigger new build. |
|
Docs Build status updates of commit dc598de: ✅ 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:
|
|
Think there's just the two fixes for my comments and this is ready to go! |
Co-authored-by: Michael Hawker MSFT (XAML Llama) <[email protected]>
|
Docs Build status updates of commit 1075a12: ✅ 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 1075a12: ✅ 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 d3d83a4: ✅ 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 d99dbc7:
|
|
Docs Build status updates of commit a6b84d5:
|
Kyaa-dost
reviewed
Dec 4, 2020
Kyaa-dost
reviewed
Dec 4, 2020
Kyaa-dost
approved these changes
Dec 4, 2020
Co-authored-by: Kyaa Dost <[email protected]>
Co-authored-by: Kyaa Dost <[email protected]>
|
Docs Build status updates of commit cb61405:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml | View | Details | |
| docs/developer-tools/ThrowHelper.md | ✅Succeeded | View | |
| docs/toc.md | ✅Succeeded | View |
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.TypedEventHandler`2'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource.AnimatedVisualInvalidated'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyObject'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.ActivatableAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.MarshalingBehaviorAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.StaticAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.ThreadingAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.VersionAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisual'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Composition.Compositor'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource.TryCreateAnimatedVisual(Windows.UI.Composition.Compositor,System.Object@)'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IAsyncAction'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Uri'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IAsyncAction'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Storage.StorageFile'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.DefaultOverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Storage.StorageFile'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable.ToString'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Uri'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable.ToString'.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
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.
Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching in the Docs contributor and Admin Guide
- See the frequently asked questions
- Post your question in the Docs support channel
|
Docs Build status updates of commit 30b2e23:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml | View | Details | |
| docs/developer-tools/ThrowHelper.md | ✅Succeeded | View | |
| docs/toc.md | ✅Succeeded | View |
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Storage.StorageFile'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisual'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Composition.Compositor'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource.TryCreateAnimatedVisual(Windows.UI.Composition.Compositor,System.Object@)'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.TypedEventHandler`2'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource.AnimatedVisualInvalidated'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable.ToString'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyObject'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.ActivatableAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.MarshalingBehaviorAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.StaticAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.ThreadingAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.VersionAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Uri'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable.ToString'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IAsyncAction'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Uri'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IAsyncAction'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Storage.StorageFile'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.DefaultOverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
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.
Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching in the Docs contributor and Admin Guide
- See the frequently asked questions
- Post your question in the Docs support channel
|
Docs Build status updates of commit 30b2e23:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml | View | Details | |
| docs/developer-tools/ThrowHelper.md | ✅Succeeded | View | |
| docs/toc.md | ✅Succeeded | View |
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Lottie/LottieVisualSource.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.TypedEventHandler`2'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource.AnimatedVisualInvalidated'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisual'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Composition.Compositor'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource.TryCreateAnimatedVisual(Windows.UI.Composition.Compositor,System.Object@)'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Uri'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Storage.StorageFile'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable.ToString'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IAsyncAction'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Uri'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IAsyncAction'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Storage.StorageFile'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.DefaultOverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.OverloadAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.UI.Xaml.Controls.IDynamicAnimatedVisualSource'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.UI.Xaml.DependencyObject'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.ActivatableAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.MarshalingBehaviorAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.StaticAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.ThreadingAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.Metadata.VersionAttribute'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Windows.Foundation.IStringable.ToString'.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
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.
Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching in the Docs contributor and Admin Guide
- See the frequently asked questions
- Post your question in the Docs support channel
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for Toolkit PR #3346
PR Checklist
Please check if your PR fulfills the following requirements:
masterfor new features,livefor typos/improvements)