Skip to content

Documentation Questions #153

@milesfrain

Description

@milesfrain

This looks like some typos. I'd be happy make a PR to fix it, but I don't know what it's trying to say.

The 'omnifunc' is though to provide as thigh list of results as possible,
while the user completion is though to find as many results as possible.

Is the description for :PaddType backwards? I'd expect "add type annotation to a function" to mean start with a function without a type annotation, such as:

x = 5

Then add the type annotation to turn it into:

x :: Int
x = 5

:PaddType
<Add type annotation to a function on the current line, e.g. if you use this
command over the line
>
concat :: forall a b. Show a => Show b => a -> b -> String
<
It will produce:
>
concat :: forall a b. Show a => Show b => a -> b -> String
concat _ _ = ?concat
<

I'd like to make the main readme a bit more beginner-friendly. For example: link to omnicompletion info, and explicitly note the syntastic plugin dependency. There are some old docs improvements PRs still pending though (#134 #139), so maybe we should get those in first. I'm happy to help with maintenance for these documentation efforts.

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