Reinstate supplemental remarks (System/I-P)#12701
Open
gewarren wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restores “supplemental remarks” content directly into the ECMA XML API reference files (instead of linking out to conceptual docs), and removes some .NET Framework-specific wording as part of that reintegration work (per dotnet-api-docs#12613).
Changes:
- Replaced “Supplemental API remarks” external links with inlined markdown remarks for several
SystemAPIs (for example,Nullable,Int32, and multiple exception types). - Updated
Math.Pow/MathF.Powremarks tables to remove .NET Framework-specific return-value notes while preserving the IEEE-754 footnote context. - Added/updated many snippet sources and snippet project files (C#/F#/VB) to support the reinstated remarks content.
Reviewed changes
Copilot reviewed 163 out of 165 changed files in this pull request and generated 17 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System/Nullable`1.xml | Inlines supplemental remarks for Nullable<T>. |
| xml/System/Nullable.xml | Inlines supplemental remarks for Nullable. |
| xml/System/NotSupportedException.xml | Inlines supplemental remarks for NotSupportedException and adds snippet includes. |
| xml/System/NotImplementedException.xml | Inlines supplemental remarks for NotImplementedException. |
| xml/System/MidpointRounding.xml | Inlines supplemental remarks for MidpointRounding. |
| xml/System/MethodAccessException.xml | Adjusts remarks formatting/content. |
| xml/System/MathF.xml | Removes .NET Framework-specific note from MathF.Pow remarks table rows. |
| xml/System/Math.xml | Removes .NET Framework-specific note from Math.Pow remarks table rows. |
| xml/System/Int32.xml | Inlines supplemental remarks for Int32 and adds snippet includes. |
| xml/System/IAsyncDisposable.xml | Inlines supplemental remarks for IAsyncDisposable. |
| snippets/visualbasic/System/Object/ToString/tostringoverload2.vb | Adds VB snippet for Object.ToString overload example. |
| snippets/visualbasic/System/Object/ToString/tostringoverload1.vb | Adds VB snippet for custom ToString overload. |
| snippets/visualbasic/System/Object/ToString/tostring3.vb | Adds VB snippet for Object.ToString override example. |
| snippets/visualbasic/System/Object/ToString/tostring2.vb | Adds VB snippet for default ToString behavior. |
| snippets/visualbasic/System/Object/ToString/tostring1.vb | Adds VB snippet for base Object.ToString. |
| snippets/visualbasic/System/Object/ToString/Project.vbproj | Adds VB snippet project for Object.ToString examples. |
| snippets/visualbasic/System/Object/ToString/customize2.vb | Adds VB snippet for list formatting extensions. |
| snippets/visualbasic/System/Object/ToString/customize1.vb | Adds VB snippet for custom list ToString. |
| snippets/visualbasic/System/Object/ToString/array1.vb | Adds VB snippet demonstrating array/list ToString. |
| snippets/visualbasic/System/Object/GetHashCode/xor2.vb | Adds VB snippet for GetHashCode via HashCode.Combine. |
| snippets/visualbasic/System/Object/GetHashCode/xor1.vb | Adds VB snippet for XOR-based hash code example. |
| snippets/visualbasic/System/Object/GetHashCode/shift1.vb | Adds VB snippet for shift-and-wrap hash code example. |
| snippets/visualbasic/System/Object/GetHashCode/Project.vbproj | Adds VB snippet project for Object.GetHashCode examples. |
| snippets/visualbasic/System/Object/GetHashCode/direct1.vb | Adds VB snippet for direct hash code return example. |
| snippets/visualbasic/System/Object/Finalize/finalize_safe.vb | Adds VB snippet demonstrating safe-handle cleanup pattern. |
| snippets/visualbasic/System/Object/Equals/Project.vbproj | Adds VB snippet project for Object.Equals examples. |
| snippets/visualbasic/System/Object/Equals/equalssb1.vb | Adds VB snippet for StringBuilder.Equals behavior. |
| snippets/visualbasic/System/Object/Equals/equalsoverride.vb | Adds VB snippet for overriding Equals/GetHashCode. |
| snippets/visualbasic/System/Object/Equals/equals4.vb | Adds VB snippet for value-type equality operator example. |
| snippets/visualbasic/System/Object/Equals/equals3.vb | Adds VB snippet for rectangle/point equality example. |
| snippets/visualbasic/System/Object/Equals/equals2.vb | Adds VB snippet for inheritance equality example. |
| snippets/visualbasic/System/Object/Equals/equals_val2.vb | Adds VB snippet for value-type default equality example. |
| snippets/visualbasic/System/Object/Equals/equals_val1.vb | Adds VB snippet for boxed value equality example. |
| snippets/visualbasic/System/Object/Equals/equals_ref.vb | Adds VB snippet for reference equality example. |
| snippets/visualbasic/System/NotSupportedException/Overview/TestProp2.vb | Adds VB snippet for checking stream state before reading. |
| snippets/visualbasic/System/NotSupportedException/Overview/TestProp1.vb | Adds VB snippet that triggers NotSupportedException on read. |
| snippets/visualbasic/System/NotSupportedException/Overview/Project.vbproj | Adds VB snippet project for NotSupportedException examples. |
| snippets/visualbasic/System/NotSupportedException/Overview/BadState1.vb | Adds VB snippet demonstrating unsupported write on read-only stream. |
| snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/project.vbproj | Adds VB WinForms snippet project. |
| snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/My Project/Application.myapp | Adds VB WinForms application metadata. |
| snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/Form11.vb | Adds VB WinForms snippet code-behind variant. |
| snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/Form11.Designer.vb | Adds VB WinForms designer file (Form11). |
| snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/Form1.vb | Adds VB WinForms snippet code-behind (Form1). |
| snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/Form1.Designer.vb | Adds VB WinForms designer file (Form1). |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Project.vbproj | Adds VB snippet project for “Other” invalid operation examples. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Nullable2.vb | Adds VB snippet demonstrating safe nullable handling. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Nullable1.vb | Adds VB snippet demonstrating invalid nullable cast behavior. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/List_Sort4.vb | Adds VB snippet sorting with comparison delegate. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/List_Sort3.vb | Adds VB snippet sorting with comparer. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/List_Sort2.vb | Adds VB snippet sorting via IComparable. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/List_Sort1.vb | Adds VB snippet showing sort failure without comparability. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Iterating3.vb | Adds VB snippet for safe iteration via temp collection. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Iterating2.vb | Adds VB snippet demonstrating iteration while mutating via index loop. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Iterating1.vb | Adds VB snippet demonstrating iterator invalidation. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Enumerable6.vb | Adds VB snippet demonstrating SingleOrDefault failure case. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Enumerable5.vb | Adds VB snippet demonstrating Single failure case. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Enumerable4.vb | Adds VB snippet demonstrating FirstOrDefault empty case. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Enumerable3.vb | Adds VB snippet demonstrating First empty case. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Enumerable2.vb | Adds VB snippet for guarding Average() on empty sequence. |
| snippets/visualbasic/System/InvalidOperationException/Overview/Other/Enumerable1.vb | Adds VB snippet demonstrating Average() empty-sequence exception. |
| snippets/visualbasic/System/InvalidCastException/Overview/Project.vbproj | Adds VB snippet project for InvalidCastException examples. |
| snippets/visualbasic/System/InvalidCastException/Overview/Interface1.vb | Adds VB snippet demonstrating invalid interface cast. |
| snippets/visualbasic/System/InvalidCastException/Overview/iconvertible1.vb | Adds VB snippet demonstrating invalid IConvertible conversion. |
| snippets/visualbasic/System/InvalidCastException/Overview/basetoderived1.vb | Adds VB snippet demonstrating invalid base-to-derived cast. |
| snippets/visualbasic/System/Int64/Overview/Project.vbproj | Adds VB snippet project for Int64 overview examples. |
| snippets/visualbasic/System/Int64/Overview/instantiate1.vb | Adds VB snippet for Int64 instantiation patterns. |
| snippets/visualbasic/System/Int64/Overview/formatting1.vb | Adds VB snippet for Int64 formatting examples. |
| snippets/visualbasic/System/Int32/Overview/Project.vbproj | Adds VB snippet project for Int32 overview examples. |
| snippets/visualbasic/System/Int32/Overview/Instantiate1.vb | Adds VB snippet for Int32 instantiation patterns. |
| snippets/visualbasic/System/Int32/Overview/Formatting1.vb | Adds VB snippet for Int32 formatting examples. |
| snippets/visualbasic/System/IDisposable/Overview/Project.vbproj | Adds VB snippet project for IDisposable examples. |
| snippets/visualbasic/System/IDisposable/Overview/derived1.vb | Adds VB snippet for derived dispose pattern. |
| snippets/visualbasic/System/IDisposable/Overview/calling2.vb | Adds VB snippet for manual disposal pattern. |
| snippets/visualbasic/System/IDisposable/Overview/calling1.vb | Adds VB snippet for Using disposal pattern. |
| snippets/visualbasic/System/IDisposable/Overview/base2.vb | Adds VB snippet for finalizer-based dispose pattern. |
| snippets/visualbasic/System/IDisposable/Overview/base1.vb | Adds VB snippet for base dispose pattern. |
| snippets/fsharp/System/Object/ToString/tostringoverload2.fs | Adds F# snippet for culture-aware formatting via ToString. |
| snippets/fsharp/System/Object/ToString/tostringoverload1.fs | Adds F# snippet for custom formatting overload. |
| snippets/fsharp/System/Object/ToString/tostring3.fs | Adds F# snippet for ToString override. |
| snippets/fsharp/System/Object/ToString/tostring2.fs | Adds F# snippet for default ToString behavior. |
| snippets/fsharp/System/Object/ToString/tostring1.fs | Adds F# snippet for base Object.ToString. |
| snippets/fsharp/System/Object/ToString/customize2.fs | Adds F# snippet for list formatting extensions. |
| snippets/fsharp/System/Object/ToString/customize1.fs | Adds F# snippet for custom list ToString. |
| snippets/fsharp/System/Object/ToString/array1.fs | Adds F# snippet demonstrating array/list ToString. |
| snippets/fsharp/System/Object/GetHashCode/xor2.fs | Adds F# snippet for HashCode.Combine hashing. |
| snippets/fsharp/System/Object/GetHashCode/xor1.fs | Adds F# snippet for XOR-based hashing. |
| snippets/fsharp/System/Object/GetHashCode/shift1.fs | Adds F# snippet for shift-and-wrap hashing. |
| snippets/fsharp/System/Object/GetHashCode/Project.fsproj | Adds F# snippet project for GetHashCode examples. |
| snippets/fsharp/System/Object/GetHashCode/direct1.fs | Adds F# snippet for direct hash code example. |
| snippets/fsharp/System/Object/Finalize/finalize_safe.fs | Adds F# snippet for safe-handle cleanup pattern. |
| snippets/fsharp/System/Object/Equals/Project.fsproj | Adds F# snippet project for Equals examples. |
| snippets/fsharp/System/Object/Equals/equalssb1.fs | Adds F# snippet for StringBuilder.Equals behavior. |
| snippets/fsharp/System/Object/Equals/equalsoverride.fs | Adds F# snippet for overriding Equals/GetHashCode. |
| snippets/fsharp/System/Object/Equals/equals4.fs | Adds F# snippet for value-type equality operator example. |
| snippets/fsharp/System/Object/Equals/equals3.fs | Adds F# snippet for rectangle/point equality example. |
| snippets/fsharp/System/Object/Equals/equals2.fs | Adds F# snippet for inheritance equality example. |
| snippets/fsharp/System/Object/Equals/equals_val2.fs | Adds F# snippet for value-type default equality example. |
| snippets/fsharp/System/Object/Equals/equals_val1.fs | Adds F# snippet for boxed value equality example. |
| snippets/fsharp/System/Object/Equals/equals_ref.fs | Adds F# snippet for reference equality example. |
| snippets/fsharp/System/Int64/Overview/instantiate1.fs | Adds F# snippet for Int64 instantiation patterns. |
| snippets/fsharp/System/Int32/Overview/toint32_1.fs | Adds F# snippet for Convert.ToInt32 usage. |
| snippets/fsharp/System/Int32/Overview/Instantiate1.fs | Adds F# snippet for Int32 instantiation patterns. |
| snippets/fsharp/System/Int32/Overview/Formatting1.fs | Adds F# snippet for Int32 formatting examples. |
| snippets/csharp/System/Object/ToString/tostringoverload2.cs | Adds C# snippet for culture-aware formatting via ToString. |
| snippets/csharp/System/Object/ToString/tostringoverload1.cs | Adds C# snippet for custom formatting overload. |
| snippets/csharp/System/Object/ToString/tostring3.cs | Adds C# snippet for ToString override. |
| snippets/csharp/System/Object/ToString/tostring2.cs | Adds C# snippet for default ToString behavior. |
| snippets/csharp/System/Object/ToString/tostring1.cs | Adds C# snippet for base Object.ToString. |
| snippets/csharp/System/Object/ToString/Project.csproj | Adds C# snippet project for Object.ToString examples. |
| snippets/csharp/System/Object/ToString/customize2.cs | Adds C# snippet for list formatting extensions. |
| snippets/csharp/System/Object/ToString/customize1.cs | Adds C# snippet for custom list ToString. |
| snippets/csharp/System/Object/ToString/array1.cs | Adds C# snippet demonstrating array/list ToString. |
| snippets/csharp/System/Object/GetHashCode/xor2.cs | Adds C# snippet for HashCode.Combine hashing. |
| snippets/csharp/System/Object/GetHashCode/xor1.cs | Adds C# snippet for XOR-based hashing. |
| snippets/csharp/System/Object/GetHashCode/shift1.cs | Adds C# snippet for shift-and-wrap hashing. |
| snippets/csharp/System/Object/GetHashCode/Project.csproj | Adds C# snippet project for GetHashCode examples. |
| snippets/csharp/System/Object/GetHashCode/direct1.cs | Adds C# snippet for direct hash code example. |
| snippets/csharp/System/Object/Finalize/finalize_safe.cs | Adds C# snippet for safe-handle cleanup pattern. |
| snippets/csharp/System/Object/Equals/Project.csproj | Adds C# snippet project for Equals examples. |
| snippets/csharp/System/Object/Equals/equalssb1.cs | Adds C# snippet for StringBuilder.Equals behavior. |
| snippets/csharp/System/Object/Equals/equalsoverride.cs | Adds C# snippet for overriding Equals/GetHashCode. |
| snippets/csharp/System/Object/Equals/equals4.cs | Adds C# snippet for value-type equality operator example. |
| snippets/csharp/System/Object/Equals/equals3.cs | Adds C# snippet for rectangle/point equality example. |
| snippets/csharp/System/Object/Equals/equals2.cs | Adds C# snippet for inheritance equality example. |
| snippets/csharp/System/Object/Equals/equals_val2.cs | Adds C# snippet for value-type default equality example. |
| snippets/csharp/System/Object/Equals/equals_val1.cs | Adds C# snippet for boxed value equality example. |
| snippets/csharp/System/Object/Equals/equals_static2.cs | Renames snippet class to avoid type-name collision. |
| snippets/csharp/System/Object/Equals/equals_ref.cs | Adds C# snippet for reference equality example. |
| snippets/csharp/System/NotSupportedException/Overview/TestProp2.cs | Adds C# snippet for checking stream state before reading. |
| snippets/csharp/System/NotSupportedException/Overview/TestProp1.cs | Adds C# snippet that triggers NotSupportedException on read. |
| snippets/csharp/System/NotSupportedException/Overview/project.csproj | Adds C# snippet project for NotSupportedException examples. |
| snippets/csharp/System/NotSupportedException/Overview/BadState1.cs | Adds C# snippet demonstrating unsupported write on read-only stream. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/project.csproj | Adds C# snippet project for “Other” invalid operation examples. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Nullable2.cs | Adds C# snippet demonstrating safe nullable handling. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Nullable1.cs | Adds C# snippet demonstrating invalid nullable cast behavior. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/List_Sort4.cs | Adds C# snippet sorting with comparison delegate. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/List_Sort3.cs | Adds C# snippet sorting with comparer. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/List_Sort2.cs | Adds C# snippet sorting via IComparable. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/List_Sort1.cs | Adds C# snippet showing sort failure without comparability. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Iterating3.cs | Adds C# snippet for safe iteration via temp collection. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Iterating2.cs | Adds C# snippet demonstrating iteration while mutating via index loop. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Iterating1.cs | Adds C# snippet demonstrating iterator invalidation. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Enumerable6.cs | Adds C# snippet demonstrating SingleOrDefault failure case. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Enumerable5.cs | Adds C# snippet demonstrating Single failure case. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Enumerable4.cs | Adds C# snippet demonstrating FirstOrDefault empty case. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Enumerable3.cs | Adds C# snippet demonstrating First empty case. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Enumerable2.cs | Adds C# snippet for guarding Average() on empty sequence. |
| snippets/csharp/System/InvalidOperationException/Overview/Other/Enumerable1.cs | Adds C# snippet demonstrating Average() empty-sequence exception. |
| snippets/csharp/System/InvalidCastException/Overview/ToString2.cs | Adds C# snippet showing safe ToString call. |
| snippets/csharp/System/InvalidCastException/Overview/ToString1.cs | Adds C# snippet demonstrating invalid cast. |
| snippets/csharp/System/InvalidCastException/Overview/project.csproj | Adds C# snippet project for InvalidCastException examples. |
| snippets/csharp/System/InvalidCastException/Overview/Interface1.cs | Adds C# snippet demonstrating invalid interface cast. |
| snippets/csharp/System/InvalidCastException/Overview/iconvertible1.cs | Adds C# snippet demonstrating invalid IConvertible conversion. |
| snippets/csharp/System/InvalidCastException/Overview/basetoderived1.cs | Adds C# snippet demonstrating invalid base-to-derived cast. |
| snippets/csharp/System/Int64/Overview/Project.csproj | Adds C# snippet project for Int64 overview examples. |
| snippets/csharp/System/Int64/Overview/instantiate1.cs | Adds C# snippet for Int64 instantiation patterns. |
| snippets/csharp/System/Int64/Overview/formatting1.cs | Adds C# snippet for Int64 formatting examples. |
| snippets/csharp/System/Int32/Overview/Project.csproj | Adds C# snippet project for Int32 overview examples. |
| snippets/csharp/System/Int32/Overview/Instantiate1.cs | Adds C# snippet for Int32 instantiation patterns. |
| snippets/csharp/System/Int32/Overview/Formatting1.cs | Adds C# snippet for Int32 formatting examples. |
Files not reviewed (2)
- snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/Form1.Designer.vb: Language not supported
- snippets/visualbasic/System/InvalidOperationException/Overview/WinForms/Form11.Designer.vb: Language not supported
Contributor
Author
|
Snippets 5000 errors are for missing .fsproj files. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Contributes to #12613.
Also removes .NET Framework remarks.