google / google/vimdoc

Vimdoc needs some way to continue long @throws lines

Open
#22 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
306
Forks
30
PR merge metrics
No merged PRs in 30d

Description

We got rid of pipe line continuations in vimdoc. That means currently there's no way to have an `@throws` line longer than 80 characters.

Given this vimdoc comment:

```
" @throws Ambiguous if {name} refers to multiple plugins/packages within one
" source.
```

Vimdoc currently creates an awkward line wrap in the output:

```
Throws ERROR(Ambiguous) if {name} refers to multiple plugins/packages within
one
source.
```

We discussed having the convention for continuing directive lines be a standard 4-space indent:

```
" @throws Ambiguous if {name} refers to multiple plugins/packages within one
" source.
```

Other directives like `@tagline` and `@order` will need this as well.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.