Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,26 @@ Plug 'heavenshell/vim-jsdoc', {
\}
```

<details><summary>PlugUpdate error</summary>
<p>
If you got `yarn.lock` related error,

```console
error: Your local changes to the following files would be overwritten by merge:
lib/yarn.lock
```

Run following command

```
cd /path/to/plugged/vim-jsdoc
git checkout -- yarn.lock
```

and re-run `PlugUpdate`
</p>
</details>

### Manual Installation

Since version 2.0.0, jsdoc.vim requires a local copy [lehre](https://www.npmjs.com/package/lehre) installed to the plugin directory.
Expand Down
5 changes: 5 additions & 0 deletions doc/jsdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,11 @@ g:jsdoc_lehre_path *g:jsdoc_lehre_path*
>
==============================================================================
CHANGELOG *jsdoc-changelog*
2021-02-15
- Update README
See https://github.com/heavenshell/vim-jsdoc/issues/103 details.
(thx @boblannon)

2020-10-10
- Fix async bug
See https://github.com/heavenshell/vim-jsdoc/issues/99 details.
Expand Down