https://github.com/claymcleod/googledocstrings.vim

https://github.com/claymcleod/googledocstrings.vim

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/claymcleod/googledocstrings.vim
• Owner: claymcleod
• Created: 2017-06-04T17:39:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-04T21:19:36.000Z (over 7 years ago)
• Last Synced: 2024-11-04T00:02:20.046Z (3 months ago)
• Language: Vim script
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This is a VIM plugin I wrote to satisfy my personal needs during Python documentation. There are many things I didn't bother to test, such as tabs instead of spaces. If there are things you'd like to see, submit a pull request!

TODO

----

* Assumes you use spaces instead of tabs.

Usage

-----

I've added this to my .vimrc

```

let g:googledocstrings_author = 'clay'

let g:googledocstrings_todo = 'TODO_DOC(clay)'

nnoremap d :GoogleDocstringsGen

nnoremap t /TODO_DOC(clay):nohdEa

```

When you are ready to write documentation for you module

you can use `d`, then `t` repeatedly filling

in information until it is complete.