Skip to content

Commit 8fcd62d

Browse files
fix: indicate optional arguments with the word 'optional' (vuejs#442)
1 parent 009bed1 commit 8fcd62d

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/api/application-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In addition, since the `createApp` method returns the application instance itsel
1717
- **Arguments:**
1818

1919
- `{string} name`
20-
- `{Function | Object} [definition]`
20+
- `{Function | Object} definition (optional)`
2121

2222
- **Returns:**
2323

@@ -68,7 +68,7 @@ app.config = {...}
6868
- **Arguments:**
6969

7070
- `{string} name`
71-
- `{Function | Object} [definition]`
71+
- `{Function | Object} definition (optional)`
7272

7373
- **Returns:**
7474

@@ -181,7 +181,7 @@ Apart from `el`, you should treat these arguments as read-only and never modify
181181
- **Arguments:**
182182

183183
- `{Element | string} rootContainer`
184-
- `{boolean} isHydrate`
184+
- `{boolean} isHydrate (optional)`
185185

186186
- **Returns:**
187187

@@ -291,7 +291,7 @@ setTimeout(() => app.unmount('#my-app'), 5000)
291291
- **Arguments:**
292292

293293
- `{Object | Function} plugin`
294-
- `[...options]`
294+
- `...options (optional)`
295295

296296
- **Returns:**
297297

src/api/instance-methods.md

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

77
- `{string | Function} source`
88
- `{Function | Object} callback`
9-
- `{Object} [options]`
9+
- `{Object} options (optional)`
1010
- `{boolean} deep`
1111
- `{boolean} immediate`
1212

@@ -177,7 +177,7 @@
177177
- **Arguments:**
178178

179179
- `{string} eventName`
180-
- `[...args]`
180+
- `...args (optional)`
181181

182182
Trigger an event on the current instance. Any additional arguments will be passed into the listener's callback function.
183183

@@ -259,7 +259,7 @@
259259

260260
- **Arguments:**
261261

262-
- `{Function} [callback]`
262+
- `{Function} callback (optional)`
263263

264264
- **Usage:**
265265

0 commit comments

Comments
 (0)