Skip to content

Commit 82b1042

Browse files
authored
Add PlugUpdate error to README (#104)
* Add plugupdate error * Update doc
1 parent 5487673 commit 82b1042

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,26 @@ Plug 'heavenshell/vim-jsdoc', {
2525
\}
2626
```
2727

28+
<details><summary>PlugUpdate error</summary>
29+
<p>
30+
If you got `yarn.lock` related error,
31+
32+
```console
33+
error: Your local changes to the following files would be overwritten by merge:
34+
lib/yarn.lock
35+
```
36+
37+
Run following command
38+
39+
```
40+
cd /path/to/plugged/vim-jsdoc
41+
git checkout -- yarn.lock
42+
```
43+
44+
and re-run `PlugUpdate`
45+
</p>
46+
</details>
47+
2848
### Manual Installation
2949

3050
Since version 2.0.0, jsdoc.vim requires a local copy [lehre](https://www.npmjs.com/package/lehre) installed to the plugin directory.

doc/jsdoc.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@ g:jsdoc_lehre_path *g:jsdoc_lehre_path*
116116
>
117117
==============================================================================
118118
CHANGELOG *jsdoc-changelog*
119+
2021-02-15
120+
- Update README
121+
See https://github.com/heavenshell/vim-jsdoc/issues/103 details.
122+
(thx @boblannon)
123+
119124
2020-10-10
120125
- Fix async bug
121126
See https://github.com/heavenshell/vim-jsdoc/issues/99 details.

0 commit comments

Comments
 (0)