Skip to content

Commit e05fb50

Browse files
Modernize GetLogicalDrives docs
1 parent 35a8cb8 commit e05fb50

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

xml/System.IO/Directory.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4055,13 +4055,13 @@ The returned collection is not cached. Each call to the <xref:System.Collections
40554055
</ReturnValue>
40564056
<Parameters />
40574057
<Docs>
4058-
<summary>Retrieves the names of the logical drives on this computer in the form "&lt;drive letter&gt;:\\".</summary>
4059-
<returns>The logical drives on this computer.</returns>
4058+
<summary>Retrieves the names of the logical drives on this computer.</summary>
4059+
<returns>An array of strings representing the logical drive names.</returns>
40604060
<remarks>
40614061
<format type="text/markdown"><![CDATA[
40624062
40634063
## Remarks
4064-
GetLogicalDrives returns all of the accessible drives on a particular machine, including the floppy drive and any optical drives.
4064+
On Windows, `GetLogicalDrives` returns the names of all accessible drives on a particular machine, including any optical drives or removable media devices, in the form "\<drive letter\>:\\" (for example, "C:\\"). On Unix, it returns the paths of all filesystem mount points mounted on a particular machine (for example, "/home/user", "/media/usb").
40654065
40664066
For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).
40674067

xml/System/Environment.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,11 +1421,14 @@ The following example creates environment variables for the <xref:System.Environ
14211421
</ReturnValue>
14221422
<Parameters />
14231423
<Docs>
1424-
<summary>Returns an array of string containing the names of the logical drives on the current computer.</summary>
1425-
<returns>An array of strings where each element contains the name of a logical drive. For example, if the computer's hard drive is the first logical drive, the first element returned is "C:\\".</returns>
1424+
<summary>Retrieves the names of the logical drives on this computer.</summary>
1425+
<returns>An array of strings representing the logical drive names.</returns>
14261426
<remarks>
14271427
<format type="text/markdown"><![CDATA[
14281428
1429+
## Remarks
1430+
On Windows, `GetLogicalDrives` returns the names of all accessible drives on a particular machine, including any optical drives or removable media devices, in the form "\<drive letter\>:\\" (for example, "C:\\"). On Unix, it returns the paths of all filesystem mount points mounted on a particular machine (for example, "/home/user", "/media/usb").
1431+
14291432
## Examples
14301433
The following example shows how to display the logical drives of the current computer using the <xref:System.Environment.GetLogicalDrives%2A> method.
14311434

0 commit comments

Comments
 (0)