8000 Documentation is inconsistent with what comes first: command or explanation · Issue #1018 · gokcehan/lf · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000
Documentation is inconsistent with what comes first: command or explanation #1018
Closed
@marcelourbanolima

Description

@marcelourbanolima

I'm reading the documentation top to bottom and I found some inconsistencies so far.

From "Commands" section until before the "Prefixes" section the commands come before/on top of their explanation, which I think is weird and not intuitive. Then I see that other sections have the explanation before the command which I think easier to learn.

If you prefer I can submit a PR making that consistent across the documentation.

I also think that the first example of key mappings can be improved, for example with a comment:

Regular keys are assigned to a command with the usual syntax:
map a down # binds the "a" key to the "down" command

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

      0