Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions xml/System.Data/DataSet.xml
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ The following example consists of several methods that, combined, create and fil
<param name="context">Contextual information about the serialized stream.</param>
<summary>Initializes a new instance of the <see cref="T:System.Data.DataSet" /> class with serialized data.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">.NET 7 and later versions only: <paramref name="info" /> contains binary data.</exception>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException"><paramref name="info" /> contains binary data.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -389,7 +389,7 @@ The following example consists of several methods that, combined, create and fil

]]></format>
</remarks>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">.NET 7 and later versions only: <paramref name="info" /> contains binary data.</exception>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException"><paramref name="info" /> contains binary data.</exception>
</Docs>
</Member>
<Member MemberName="AcceptChanges">
Expand Down Expand Up @@ -5474,7 +5474,7 @@ class Program {
<summary>Gets or sets the serialization format for the <see cref="T:System.Data.DataSet" /> that's used during remoting.</summary>
<value>One of the enumeration values that specifies the serialization format.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">.NET 7 and later versions only: The value being set is <see cref="System.Data.SerializationFormat.Binary" />.</exception>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value being set is <see cref="System.Data.SerializationFormat.Binary" />.</exception>
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/">Using DataSets in ADO.NET</related>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Data/DataTable.xml
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ This sample demonstrates how to create a DataTable manually with specific schema
<param name="context">Contextual information about the serialized stream.</param>
<summary>Initializes a new instance of the <see cref="T:System.Data.DataTable" /> class with serialized data.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">.NET 7 and later versions only: <paramref name="info" /> contains binary data.</exception>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException"><paramref name="info" /> contains binary data.</exception>
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/datatables">DataTables</related>
</Docs>
</Member>
Expand Down Expand Up @@ -5672,7 +5672,7 @@ public class A {
<summary>Gets or sets the serialization format.</summary>
<value>One of the enumeration values that specifies the serialization format.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">.NET 7 and later versions only: The value being set is <see cref="System.Data.SerializationFormat.Binary" />.</exception>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value being set is <see cref="System.Data.SerializationFormat.Binary" />.</exception>
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/datatables">DataTables</related>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Data/SerializationFormat.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

## Remarks

The `Binary` field is obsolete starting in .NET 7, because it relies on <xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter>, which is inherently insecure.
The `Binary` field is obsolete, because it relies on <xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter>, which is inherently insecure.

The default format is `Xml`. This format is backward compatible and will work with all versions of .NET.

Expand Down Expand Up @@ -99,7 +99,7 @@ The default format is `Xml`. This format is backward compatible and will work wi
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Serialize as binary content. This field is obsolete starting in .NET 7.</summary>
<summary>Serialize as binary content. This field is obsolete.</summary>
</Docs>
</Member>
<Member MemberName="Xml">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Diagnostics.Tracing/EventWrittenEventArgs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ When using <xref:System.Activities.Activity?displayProperty=nameWithType> and it

## OSThreadId and TimeStamp properties

Starting with .NET Core 2.2, <xref:System.Diagnostics.Tracing.EventListener> objects can subscribe to native runtime events (such as GC, JIT, and threadpool events) in addition to events emitted by <xref:System.Diagnostics.Tracing.EventSource> objects. In previous versions of .NET Core and all versions of .NET Framework, the thread ID and timestamp can be gathered from the environment, because they are dispatched synchronously on the same thread that emitted them. Not all native runtime events can be dispatched synchronously, however. Some events, such as GC events, are emitted when managed thread execution is suspended. These events are buffered in native code and are dispatched by a dispatcher thread once managed code can execute again. Because these events are buffered, the environment cannot be used to reliably retrieve the thread ID and timestamp. Because of this, starting with .NET Core 2.2, thread ID and timestamp information are available as members of the `EventWrittenEventArgs` class.
<xref:System.Diagnostics.Tracing.EventListener> objects can subscribe to native runtime events (such as GC, JIT, and threadpool events) in addition to events emitted by <xref:System.Diagnostics.Tracing.EventSource> objects. Not all native runtime events can be dispatched synchronously, however. Some events, such as GC events, are emitted when managed thread execution is suspended. These events are buffered in native code and are dispatched by a dispatcher thread once managed code can execute again. Because these events are buffered, the environment cannot be used to reliably retrieve the thread ID and timestamp. Thread ID and timestamp information are available as members of the `EventWrittenEventArgs` class.

## RelatedActivityId property

Expand Down
4 changes: 2 additions & 2 deletions xml/System.Diagnostics/ActivityLink.xml
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Activity links can be used to represent batched operations where an activity was

## Remarks

<xref:System.Diagnostics.ActivityLink> equality is currently undefined. The current behavior is that two <xref:System.Diagnostics.ActivityLink> instances with the same <xref:System.Diagnostics.ActivityContext> and no tags will return `true` for <xref:System.Diagnostics.ActivityLink.Equals(System.Diagnostics.ActivityLink)>. Prior to .NET 7, <xref:System.Diagnostics.ActivityLink> instances sharing an <xref:System.Diagnostics.ActivityTagsCollection> instance and the same <xref:System.Diagnostics.ActivityContext> would return `true` for <xref:System.Diagnostics.ActivityLink.Equals(System.Diagnostics.ActivityLink)>. Starting from .NET 7, <xref:System.Diagnostics.ActivityLink.Equals(System.Diagnostics.ActivityLink)> will always return `false` when tags are used. This may change in the future. Exercise caution in calling this method.
<xref:System.Diagnostics.ActivityLink> equality is currently undefined. The current behavior is that two <xref:System.Diagnostics.ActivityLink> instances with the same <xref:System.Diagnostics.ActivityContext> and no tags return `true` for <xref:System.Diagnostics.ActivityLink.Equals(System.Diagnostics.ActivityLink)>. <xref:System.Diagnostics.ActivityLink.Equals(System.Diagnostics.ActivityLink)> returns `false` when tags are used. This might change in the future. Exercise caution when calling this method.

]]></format>
</remarks>
Expand Down Expand Up @@ -219,7 +219,7 @@ Activity links can be used to represent batched operations where an activity was
<remarks>
<format type="text/markdown"><![CDATA[

<xref:System.Diagnostics.ActivityLink> equality is currently undefined. The current behavior is that two <xref:System.Diagnostics.ActivityLink> instances with the same <xref:System.Diagnostics.ActivityContext> and no tags will return `true` for <xref:System.Diagnostics.ActivityLink.Equals(System.Object)>. Prior to .NET 7, <xref:System.Diagnostics.ActivityLink> instances sharing an <xref:System.Diagnostics.ActivityTagsCollection> instance and the same <xref:System.Diagnostics.ActivityContext> would return `true` for <xref:System.Diagnostics.ActivityLink.Equals(System.Object)>. Starting in .NET 7, <xref:System.Diagnostics.ActivityLink.Equals(System.Object)> always returns `false` when tags are used.
<xref:System.Diagnostics.ActivityLink> equality is currently undefined. The current behavior is that two <xref:System.Diagnostics.ActivityLink> instances with the same <xref:System.Diagnostics.ActivityContext> and no tags return `true` for <xref:System.Diagnostics.ActivityLink.Equals(System.Object)>. <xref:System.Diagnostics.ActivityLink.Equals(System.Object)> always returns `false` when tags are used.

]]></format>
</remarks>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Diagnostics/Debug.xml
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ The following example creates an index for an array, performs some action to set
## Remarks
This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a `String` parameter, this overload only evaluates any interpolated string formatting items if the message is required.
This overload has better performance than the overloads that take a `String` parameter. This overload only evaluates any interpolated string formatting items if the message is required.
By default, the <xref:System.Diagnostics.Debug.Assert*?displayProperty=nameWithType> method works only in debug builds. Use the <xref:System.Diagnostics.Trace.Assert*?displayProperty=nameWithType> method if you want to do assertions in release builds. For more information, see [Assertions in Managed Code](/visualstudio/debugger/assertions-in-managed-code).
Expand Down Expand Up @@ -470,7 +470,7 @@ The following example checks whether the `type` parameter is valid. If `type` is
## Remarks
This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a `String` parameter, this overload only evaluates any interpolated string formatting items if the message is required.
This overload has better performance than the overloads that take a `String` parameter. This overload only evaluates any interpolated string formatting items if the message is required.
By default, the <xref:System.Diagnostics.Debug.Assert*?displayProperty=nameWithType> method works only in debug builds. Use the <xref:System.Diagnostics.Trace.Assert*?displayProperty=nameWithType> method if you want to do assertions in release builds. For more information, see [Assertions in Managed Code](/visualstudio/debugger/assertions-in-managed-code).
Expand Down Expand Up @@ -1957,7 +1957,7 @@ The following example creates a <xref:System.Diagnostics.TraceSwitch> named `gen
## Remarks
This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a `String` parameter, this overload only evaluates any interpolated string formatting items if the message is required.
This overload has better performance than the overloads that take a `String` parameter. This overload only evaluates any interpolated string formatting items if the message is required.
By default, the output is written to an instance of <xref:System.Diagnostics.DefaultTraceListener>.
Expand Down Expand Up @@ -2235,7 +2235,7 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");
## Remarks
This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a `String` parameter, this overload only evaluates any interpolated string formatting items if the message is required.
This overload has better performance than the overloads that take a `String` parameter. This overload only evaluates any interpolated string formatting items if the message is required.
By default, the output is written to an instance of <xref:System.Diagnostics.DefaultTraceListener>.
Expand Down Expand Up @@ -2963,7 +2963,7 @@ The following example creates a <xref:System.Diagnostics.TraceSwitch> named `gen
## Remarks
This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a `String` parameter, this overload only evaluates any interpolated string formatting items if the message is required.
This overload has better performance than the overloads that take a `String` parameter. This overload only evaluates any interpolated string formatting items if the message is required.
By default, the output is written to an instance of <xref:System.Diagnostics.DefaultTraceListener>.
Expand Down Expand Up @@ -3240,7 +3240,7 @@ Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range")
## Remarks
This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a `String` parameter, this overload only evaluates any interpolated string formatting items if the message is required.
This overload has better performance than the overloads that take a `String` parameter. This overload only evaluates any interpolated string formatting items if the message is required.
By default, the output is written to an instance of <xref:System.Diagnostics.DefaultTraceListener>.
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Globalization/CompareOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@
<remarks>
<format type="text/markdown"><![CDATA[

In .NET 5 and later, the cross-platform ICU (International Components for Unicode) library is used for string processing. The ICU library brings the following changes to string comparison behavior:
The cross-platform ICU (International Components for Unicode) library is used for string processing. The ICU library has the following behaviors:

- The default option `None` is equivalent to the `StringSort` option. The previous functionality of `None`, where equal weighting was given to alphanumeric and nonalphanumeric characters, is no longer available.
- The default option `None` is equivalent to the `StringSort` option.
- Ligatures (combined characters like "æ" and "œ") are seen as distinct from their expanded forms ("ae", "oe") in string comparisons by default. To treat ligatures and their expanded forms as equivalent, use the `IgnoreNonSpace` option.

For more information about the change, including how to restore the previous Unicode handler, see [.NET globalization and ICU](/dotnet/core/extensions/globalization-icu).
For more information, see [.NET globalization and ICU](/dotnet/core/extensions/globalization-icu).

The <xref:System.Globalization.CompareOptions> options denote case sensitivity or necessity to ignore types of characters.

Expand Down
4 changes: 2 additions & 2 deletions xml/System.IO.Compression/BrotliStream.xml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">.NET 7 and later: <paramref name="compressionLevel" /> is not defined in the <see cref="System.IO.Compression.CompressionLevel" /> enumeration.</exception>
<exception cref="T:System.ArgumentException"><paramref name="compressionLevel" /> is not defined in the <see cref="System.IO.Compression.CompressionLevel" /> enumeration.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -193,7 +193,7 @@
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">.NET 7 and later: <paramref name="compressionLevel" /> is not defined in the <see cref="System.IO.Compression.CompressionLevel" /> enumeration.</exception>
<exception cref="T:System.ArgumentException"><paramref name="compressionLevel" /> is not defined in the <see cref="System.IO.Compression.CompressionLevel" /> enumeration.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
8 changes: 4 additions & 4 deletions xml/System.IO.Compression/DeflateStream.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1319,7 +1319,7 @@ This method stores in the task it returns all non-usage exceptions that the meth
<format type="text/markdown"><![CDATA[

> [!IMPORTANT]
> Starting in .NET 6, this method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).
> This method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).

Use the <xref:System.IO.Compression.DeflateStream.CanRead> property to determine whether the current instance supports reading. Use the <xref:System.IO.Compression.DeflateStream.ReadAsync*> method to read asynchronously from the current stream.

Expand Down Expand Up @@ -1389,7 +1389,7 @@ Use <xref:System.IO.BinaryReader> for reading primitive data types.
<format type="text/markdown"><![CDATA[

> [!IMPORTANT]
> Starting in .NET 6, this method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).
> This method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).

The following example shows how to compress and decompress bytes by using the <xref:System.IO.Compression.DeflateStream.Read*> and <xref:System.IO.Compression.DeflateStream.Write*> methods.

Expand Down Expand Up @@ -1460,7 +1460,7 @@ The following example shows how to compress and decompress bytes by using the <x
<format type="text/markdown"><![CDATA[

> [!IMPORTANT]
> Starting in .NET 6, this method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).
> This method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).

The `ReadAsync` method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in desktop apps where a time-consuming stream operation can block the UI thread and make the app appear as if it's not working. The async methods are used in conjunction with the `async` and `await` keywords in Visual Basic and C#.

Expand Down Expand Up @@ -1526,7 +1526,7 @@ If the operation is canceled before it completes, the returned task contains the
<format type="text/markdown"><![CDATA[

> [!IMPORTANT]
> Starting in .NET 6, this method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).
> This method might not read as many bytes as were requested. For more information, see [Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream](/dotnet/core/compatibility/core-libraries/6.0/partial-byte-reads-in-streams).

The `ReadAsync` method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in desktop apps where a time-consuming stream operation can block the UI thread and make the app appear as if it's not working. The async methods are used in conjunction with the `async` and `await` keywords in Visual Basic and C#.

Expand Down
Loading
Loading