Skip to content

Commit 7090859

Browse files
authored
Fix DbDataSource documentation. (dotnet#8319)
1 parent ba23c93 commit 7090859

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

xml/System.Data.Common/DbDataSource.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,15 @@
144144
</ReturnValue>
145145
<Parameters />
146146
<Docs>
147-
<summary>Returns a <see cref="T:System.Data.Common.DbBatch" /> that's ready for execution against the <see cref="T:System.Data.Common.DbDataSource" />.</summary>
148-
<returns>A <see cref="T:System.Data.Common.DbBatch" /> that's ready for execution against the <see cref="T:System.Data.Common.DbDataSource" />.</returns>
147+
<summary>Returns a new, closed connection to the database represented by this <see cref="T:System.Data.Common.DbDataSource" />.</summary>
148+
<returns>A new, closed connection to the database represented by this <see cref="T:System.Data.Common.DbDataSource" />.</returns>
149149
<remarks>
150150
<format type="text/markdown"><![CDATA[
151151
152152
## Remarks
153-
Batches returned from this method are already configured to execute against their originating <xref:System.Data.Common.DbDataSource>; their <xref:System.Data.Common.DbBatch.Connection%2A> does not need to be set, and doing so will throw an exception.
153+
The connection must be opened before it can be used.
154154
155-
Since these batches have no explicitly-managed connection, it is not possible to use them with transactions, and trying to set <xref:System.Data.Common.DbBatch.Transaction%2A> will throw an exception.
155+
It is the responsibility of the caller to properly dispose the connection returned by this method. Failure to do so may result in a connection leak.
156156
157157
]]></format>
158158
</remarks>
@@ -175,8 +175,8 @@
175175
</ReturnValue>
176176
<Parameters />
177177
<Docs>
178-
<summary>Returns a new, closed connection to the database represented by this <see cref="T:System.Data.Common.DbDataSource" />.</summary>
179-
<returns>A new, closed connection to the database represented by this <see cref="T:System.Data.Common.DbDataSource" />.</returns>
178+
<summary>Returns a <see cref="T:System.Data.Common.DbBatch" /> that's ready for execution against the <see cref="T:System.Data.Common.DbDataSource" />.</summary>
179+
<returns>A <see cref="T:System.Data.Common.DbBatch" /> that's ready for execution against the <see cref="T:System.Data.Common.DbDataSource" />.</returns>
180180
<remarks>
181181
<format type="text/markdown"><![CDATA[
182182
@@ -235,8 +235,8 @@
235235
</ReturnValue>
236236
<Parameters />
237237
<Docs>
238-
<summary>Returns a <see cref="T:System.Data.Common.DbBatch" /> that's ready for execution against the <see cref="T:System.Data.Common.DbDataSource" />.</summary>
239-
<returns>A <see cref="T:System.Data.Common.DbBatch" /> that's ready for execution against the <see cref="T:System.Data.Common.DbDataSource" />.</returns>
238+
<summary>Returns a new, closed connection to the database represented by this <see cref="T:System.Data.Common.DbDataSource" />.</summary>
239+
<returns>A new, closed connection to the database represented by this <see cref="T:System.Data.Common.DbDataSource" />.</returns>
240240
<remarks>
241241
<format type="text/markdown"><![CDATA[
242242

0 commit comments

Comments
 (0)