search

heavenshell / vim-pydocstring

Generate Python docstring to your Python source code.
BSD 3-Clause "New" or "Revised" License
337 stars 53 forks source link

Fixed default mapping value in documentation #125

Closed PierrickRauby closed 3 years ago

PierrickRauby commented 3 years ago

Fixed default value in documentation to match actual default value for nmap. The actual default value is l (lowercase L) and not 1 (one) as presented in the documentation . Additionally, is the default mapping to switch to the left on horizontal split screen, so another default mapping might be better.

heavenshell commented 3 years ago

Thank you for sending me PR. But I'm so sorry, this PR breaks backward compatible. So I can't accept this PR.

I don't want BCBreak . If you don't like default mapping, you may off default mapping and add your mapping to vimrc.

Honesty I've been regretting for add default mapping to plugin.

PierrickRauby commented 3 years ago

Thanks for the answer, I have ended up changing the default mapping too and everything is working nice! Great plugin :) Do you think you could fix the documentation to reflect the actual default mapping ? Documentation says "" but actual mapping is "". I was actually surprised that the tests failed by changing the documentation file

heavenshell commented 3 years ago

@PierrickRauby

Thank you for understanding!

Do you think you could fix the documentation to reflect the actual default mapping ?

Improving document is always welcome 😊