Skip to content

dapui docs aren't correctly formatted for help syntax #439

@idbrii

Description

@idbrii

dapui docs incorrectly use ~ and don't separate arguments (so it blends into a wall of text).

Compare:

                                                                  *dapui.eval()*
`eval`({expr}, {args})

Open a floating window containing the result of evaluting an expression

If no fixed dimensions are given, the window will expand to fit the contents
of the buffer.
Parameters~
{expr?} `(string)` Expression to evaluate. If nil, then in normal more the
current word is used, and in visual mode the currently highlighted text.
{args?} `(dapui.EvalArgs)`

Image

To nvim docs:

nvim_eval({expr})                                                *nvim_eval()*
    Evaluates a Vimscript |expression|. Dicts and Lists are recursively
    expanded.

    On execution error: fails with Vimscript error, updates v:errmsg.

    Parameters: ~
      • {expr}  Vimscript expression string

    Return: ~
        Evaluation result or expanded object

Image

dap's docs also look like nvim's.

Looks like dapui uses scripts/gendocs.lua to convert ldoc to vimhelp. Maybe it'd be better to adapt https://github.com/neovim/neovim/blob/master/src/gen/gen_vimdoc.lua to generate docs consistent with nvim's style.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions