*diffscuss.txt* Diffscuss.vim: Code Reviews. In Plain Text.    *diffscuss*

CONTENTS                                              *diffscuss-contents*

1. About                                              |diffscuss-about|
2. Configuration                                      |diffscuss-config|
3. Keys                                               |diffscuss-keys|

===========================================================================
1. ABOUT                                              *diffscuss-about*

Diffscuss.vim is a Vim plugin for working with Diffscuss files. It offers
syntax highlighting, comment insertion, commands for jumping to source files,
motions for comments and threads, and easy access to the Diffscuss mailbox
scripts from within Vim.

===========================================================================
2. CONFIGURATION                                      *diffscuss-config*

The Vim plugin will use its environment and 'git config' to determine your name
and email (for pre-filling comments) and for various runtime paths.

If you wish, you can override these settings by specifying some or all of a
`g:diffscuss_config` dictionary in your `.vimrc`: >

    let g:diffscuss_config = {
        \'author': 'Your Name',
        \'email': 'your.email@example.com',
        \'diffscuss_dir': '/path/to/diffscuss',
        \'python': '/path/to/python'
        \}
<

===========================================================================
3. KEYS                                               *diffscuss-keys*

Inserting Comments

  <leader>dd    insert a new comment contextually
  <leader>df    insert a new review-level comment
  <leader>dr    insert a new reply
  <leader>di    insert a new comment

Showing the Source

  <leader>do    show the old source version
  <leader>dn    show the new source version
  <leader>ds    show the local source version

Navigation

  ]d            jump to the start of the next comment
  [d            jump to the start of the previous comment
  ]D            jump to the end of the next comment
  [D            jump to the end of the previous comment
  ]t            jump to the start of the next thread
  [t            jump to the start of the previous thread
  ]T            jump to the end of the next thread
  [T            jump to the end of the previous thread

Mailboxes

  <leader>mp    posts the current Diffscuss file
  <leader>mb    bounces the review and removes it from your inbox
  <leader>md    marks the review as done and removes it from your inbox
  <leader>mc    opens a preview window with a list of all incoming reviews


vim:tw=78:ts=8:ft=help:norl:

Add some basic in-Vim docs for the Vim plugin.
Add some basic in-Vim docs for the Vim plugin.
