Skip to content

Commit 5ef0867

Browse files
ryanoasisheavenshell
authored andcommitted
Update README.md (#76)
- Fixes markdown rendering of pipes in table by escaping them
1 parent a164cb4 commit 5ef0867

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ Option | Default | Description
3030
**g:jsdoc_return** | 1 | Add the `@return` tag.
3131
**g:jsdoc_return_type** | 1 | Prompt for and add a type for the aforementioned `@return` tag.
3232
**g:jsdoc_return_description** | 1 | Prompt for and add a description for the `@return` tag.
33-
**g:jsdoc_access_descriptions** | 0 | Set value to 1 to turn on access tags like `@access <private|public>`. Set value to 2 to turn on access tags like `@<private|public>`
33+
**g:jsdoc_access_descriptions** | 0 | Set value to 1 to turn on access tags like `@access <private\|public>`. Set value to 2 to turn on access tags like `@<private\|public>`
3434
**g:jsdoc_underscore_private** | 0 | Set value to 1 to turn on detecting underscore starting functions as private convention
3535
**g:jsdoc_allow_shorthand** | 0 | Set value to 1 to allow ECMAScript6 shorthand syntax. Since ver `0.5.0` deprecated. Use `g:jsdoc_enable_es6` instead.
3636
**g:jsdoc_param_description_separator** | ' ' | Characters used to separate `@param` name and description.
3737
**g:jsdoc_custom_args_hook** | {} | Override default type and description. See help more detail.
3838
**g:jsdoc_custom_args_regex_only** | 0 | When using `custom_args_hook`, only match against regexes
3939
**g:jsdoc_type_hook** | {} | Allow to insert default description depending on the type.
4040
**g:jsdoc_enable_es6** | 0 | Enable to use ECMAScript6's Shorthand function, Arrow function.
41-
**g:jsdoc_tags** | see :h | Allow use of alternate tags (the ones that support synonyms) per JSDoc documentation. Can be changed on a per tag basis, for example: `let g:jsdoc_tags = {} | let g:jsdoc_tags['param'] = 'arg'`
41+
**g:jsdoc_tags** | see :h | Allow use of alternate tags (the ones that support synonyms) per JSDoc documentation. Can be changed on a per tag basis, for example: `let g:jsdoc_tags = {} \| let g:jsdoc_tags['param'] = 'arg'`
4242
**g:jsdoc_user_defined_tags** | {} | Allow use of `user_defined_tags`.
4343

4444
## Keymap

0 commit comments

Comments
 (0)