Skip to content

Commit ede69bb

Browse files
committed
docs: warn about future breaking change
1 parent dcecba7 commit ede69bb

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,11 @@ pretttier-tslint file.ts
3333

3434
## API
3535

36+
3637
```js
3738
import format from "prettier-eslint";
3839

3940
format("file.ts");
4041
```
42+
43+
Currently the `format` function will write to disk and not return anything. This behavior **will change** in a minor release before `1.0.0` is released.

0 commit comments

Comments
 (0)