search

FrigoEU / psc-ide-vim

Vim plugin for psc-ide
96 stars 36 forks source link

Documentation Questions #153

Open milesfrain opened 4 years ago

milesfrain commented 4 years ago

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. https://github.com/FrigoEU/psc-ide-vim/blob/5fb4e329e5c0c7d80f0356ab4028eee9c8bd3465/doc/psc-ide-vim.txt#L6-L7

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

https://github.com/FrigoEU/psc-ide-vim/blob/5fb4e329e5c0c7d80f0356ab4028eee9c8bd3465/doc/psc-ide-vim.txt#L47-L57

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.