Skip to content

Commit e0a045d

Browse files
committed
Notice of upcoming change to input directory
1 parent a78b6ba commit e0a045d

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/deprecations.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# List of std library deprecations
22

3+
## Deprecated in 0.4.x (will be changed in 0.5.0)
4+
5+
### Special case for default input directory
6+
7+
In most cases, the input directory will be the current directory if
8+
not explicitly set with `--input-directory`.
9+
10+
However, there is a special case: if the script being run is from the
11+
filesystem, the input directory will be set to the directory
12+
containing the script.
13+
14+
This special case is deprecated. From 0.5.0, the input directory will
15+
_always default to the current working directory_ unless explicitly
16+
set with `--input-directory`.
17+
318
## Deprecated in 0.3.x (will be removed in 0.4.0)
419

520
### `generate` file property is now called path
@@ -17,9 +32,10 @@ const object = {
1732
export default [
1833
{ file: 'object0.yaml', value: object },
1934
];
20-
````
35+
```
2136

2237
**Use**:
38+
2339
```
2440
export default [
2541
{ path: 'object0.yaml', value: object },

0 commit comments

Comments
 (0)