Skip to content

Commit

Permalink
docs: Update DoGe introduction text
Browse files Browse the repository at this point in the history
  • Loading branch information
kkoomen committed Jun 21, 2019
1 parent 35b3249 commit 2a29e5f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
We all love documentation because it makes our codebases easier to understand,
yet no one has time to write it in a good and proper way.

DoGe is a [Do]cumentation [Ge]nerator which will generate instant proper
documentation based on the certain expressions (mainly functions). Simply put
your cursor on a function, press `<C-d>`(<kbd>Ctrl</kbd> + <kbd>d</kbd>), jump
DoGe is a [Do]cumentation [Ge]nerator which will generate a proper documentation
skeleton based on the certain expressions (mainly functions). Simply put your
cursor on a function, press `<C-d>`(<kbd>Ctrl</kbd> + <kbd>d</kbd>), jump
quickly through TODO items using `<Tab>` and `<S-Tab>` to quickly add
descriptions and go on coding!

Expand Down
12 changes: 6 additions & 6 deletions doc/doge.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ CONTENTS *doge-contents*
INTRODUCTION *doge-intro*

We all love documentation because it makes our codebases easier to understand,
yet no one has time to write it in a good and proper way or some might not
even like to write it.
yet no one has time to write it in a good and proper way.

DoGe is a [Do]cumentation [Ge]nerator which will generate instant proper
documentation based on the function declaration. You can simply put your
cursor on a function, press `<C-d>`, jump quickly through TODO items using
`<Tab>` and `<S-Tab>` to quickly add descriptions and go on coding!
DoGe is a [Do]cumentation [Ge]nerator which will generate a proper
documentation skeleton based on the certain expressions (mainly functions).
Simply put your cursor on a function, press `<C-d>`, jump quickly through TODO
items using `<Tab>` and `<S-Tab>` to quickly add descriptions and go on
coding!

==============================================================================
CONFIGURATION *doge-config*
Expand Down
12 changes: 6 additions & 6 deletions plugin/doge.vim
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ endif
""
" @section Introduction, intro
" We all love documentation because it makes our codebases easier to understand,
" yet no one has time to write it in a good and proper way or some might not
" even like to write it.
" yet no one has time to write it in a good and proper way.
"
" DoGe is a [Do]cumentation [Ge]nerator which will generate instant
" proper documentation based on the function declaration. You can simply put
" your cursor on a function, press `<C-d>`, jump quickly through TODO items
" using `<Tab>` and `<S-Tab>` to quickly add descriptions and go on coding!
" DoGe is a [Do]cumentation [Ge]nerator which will generate a proper
" documentation skeleton based on the certain expressions (mainly functions).
" Simply put your cursor on a function, press `<C-d>`, jump quickly through TODO
" items using `<Tab>` and `<S-Tab>` to quickly add descriptions and go on
" coding!

" }}}
" section Preprocessors, preprocessors {{{
Expand Down

0 comments on commit 2a29e5f

Please sign in to comment.