Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Questions #153

Open
milesfrain opened this issue Jun 11, 2020 · 0 comments
Open

Documentation Questions #153

milesfrain opened this issue Jun 11, 2020 · 0 comments

Comments

@milesfrain
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant