documentation for settings

vim-jp / autofmt

Text Formatting Plugin

28 stars 2 forks source link

documentation for settings #2

Closed koron closed 9 years ago

koron commented 9 years ago

autofmt can be used with these settings too:

set formatexpr=autofmt#japanese#formatexpr()
set formatexpr=autofmt#uax14#formatexpr()

It would be better, if there are documentations to explain those with usecase or so.

ynkdir commented 9 years ago

README?

diff --git a/README b/README
index 3ab12da..b23c4d7 100644
--- a/README
+++ b/README
@@ -7,4 +7,9 @@ Usage:
   :set runtimepath+=/path/to/autofmt/
   :set formatexpr=autofmt#compat#formatexpr()

+Following method can be used:
+  autofmt#compat#formatexpr():    Vim compatible
+  autofmt#uax14#formatexpr():     Implementation of UAX #14
+  autofmt#japanese#formatexpr():  Japanese
+
 See doc/autofmt.txt for more information.

koron commented 9 years ago

:+1: Yes, README would be better.

ynkdir commented 9 years ago

Fixed. Thank you.