Skip to content

Commit 6ecf874

Browse files
committed
Tense change and moving 'if's to 'when's
1 parent 5f4059b commit 6ecf874

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Mbed LS
66

7-
Mbed LS is a Python (2 and 3) module that detects and lists Mbed Enabled devices connected to the host computer. The Mbed OS team published Mbed LS on PyPI. It works on all major operating systems (Windows, Linux and Mac OS X).
7+
Mbed LS is a Python (2 and 3) module that detects and lists Mbed Enabled devices connected to the host computer. The Mbed OS team publishes Mbed LS on PyPI. It works on all major operating systems (Windows, Linux and Mac OS X).
88

99
It provides the following information for all connected boards in a console (terminal) output:
1010

@@ -134,7 +134,7 @@ $ mbedls --mock="-*"
134134

135135
It is possible to change the returned results for certain platforms depending on the current directory. This is especially useful when developing new platforms.
136136

137-
The command-line tool and Python API check the current directory for a file named `mbedls.json`. If it is present, it overrides the returned values. The format of the `mbedls.json` file is:
137+
The command-line tool and Python API check the current directory for a file named `mbedls.json`. When it is present, it overrides the returned values. The format of the `mbedls.json` file is:
138138

139139
```json
140140
{
@@ -188,13 +188,13 @@ This returns an instance that provides access to the rest of the API.
188188

189189
**Default:** `False`
190190

191-
If set to `True`, this skips the retargetting step, and the results are unmodified. This enables the same behavior as the `--skip-retarget` command-line flag.
191+
When set to `True`, this skips the retargetting step, and the results are unmodified. This enables the same behavior as the `--skip-retarget` command-line flag.
192192

193193
#### `list_unmounted`
194194

195195
**Default:** `False`
196196

197-
If set to `True`, this includes unmounted platforms in the results. This enables the same behavior as the `-u` command-line flag.
197+
When set to `True`, this includes unmounted platforms in the results. This enables the same behavior as the `-u` command-line flag.
198198

199199
## `mbeds.list_mbeds(...)`
200200

@@ -245,13 +245,13 @@ This argument controls the accuracy and speed of this function. There are three
245245

246246
**Default:** `False`.
247247

248-
Mbed LS assigns a unique name to each platform if this is set to `True`. The unique name takes the form of `K64F[0]`, where the number between the brackets is an incrementing value. This name is accessible through the dictionary member `platform_unique_name` in the returned platform data.
248+
Mbed LS assigns a unique name to each platform when this is set to `True`. The unique name takes the form of `K64F[0]`, where the number between the brackets is an incrementing value. This name is accessible through the dictionary member `platform_unique_name` in the returned platform data.
249249

250250
#### `read_details_txt`
251251

252252
**Default:** `False`
253253

254-
Mbed LS pulls more data from the file system on each device if this is set to `True`. It can provide useful management data but also takes more time to execute.
254+
Mbed LS reads more data from the file system on each device when this is set to `True`. It can provide useful management data but also takes more time to execute.
255255

256256
## `mbeds.mock_manufacture_id(...)`
257257

0 commit comments

Comments
 (0)