Skip to content

Commit cc3638b

Browse files
committed
Updates the documentation in accordance to changes in automatic date insertion (#17)
1 parent 40c964e commit cc3638b

File tree

3 files changed

+27
-10
lines changed

3 files changed

+27
-10
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -178,17 +178,16 @@ function! VimTodoListsCustomMappings()
178178
endfunction
179179
```
180180

181-
Automatic date insertion
182-
------------------------
183-
You can enable automatic date insertion by setting the following in your
184-
.vimrc:
181+
##### Automatic date insertion
182+
183+
Automatic date insertion may be enabled by setting the following in `.vimrc`:
185184

186185
```
187186
let g:VimTodoListsDatesEnabled = 1
188187
```
189188

190-
You can change the format of the date by setting the format variable to a valid
191-
strftime string like so:
189+
Date format may be changed by setting the format variable to a valid
190+
`strftime()` string:
192191

193192
```
194193
let g:VimTodoListsDatesFormat = "%a %b, %Y"
@@ -257,10 +256,12 @@ Changelog
257256

258257
#### 0.7.0
259258

260-
* Makes items list markdown compatible
261-
* Adds mappings for fast increasing/decreasing indent
259+
* Added automatic date insertion feature
260+
* Items list are made markdown compatible
261+
* Added mappings for fast increasing/decreasing indent
262262

263263
Credits
264264
-------
265265

266266
* Alexander Serebryakov, author ([GitHub](https://github.com/aserebryakov))
267+
* Jake Mason, automatic date insertion ([GitHub](https://github.com/jakemason))

doc/vim-todo-lists.txt

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,19 @@ Normal editing mode
194194
* <Space> - toggle current item
195195
* <leader>e - switch to item editing mode
196196

197+
198+
Automatic date insertion
199+
------------------------
200+
201+
Automatic date insertion may be enabled by setting the following in .vimrc:
202+
203+
let g:VimTodoListsDatesEnabled = 1
204+
205+
Date format may be changed by setting the format variable to a valid
206+
strftime() string:
207+
208+
let g:VimTodoListsDatesFormat = "%a %b, %Y"
209+
197210
==============================================================================
198211
4. Future Features *VimTodoListsFutureFeatures*
199212

@@ -277,13 +290,15 @@ SOFTWARE.
277290

278291
0.7.0
279292

280-
* Makes items list markdown compatible
281-
* Adds mappings for fast increasing/decreasing indent
293+
* Added automatic date insertion feature
294+
* Items list are made markdown compatible
295+
* Added mappings for fast increasing/decreasing indent
282296

283297
==============================================================================
284298
8. Credits *VimTodoListsCredits*
285299

286300
* Alexander Serebryakov (author) https://github.com/aserebryakov
301+
* Jake Mason (automatic date insertion) https://github.com/jakemason
287302

288303
==============================================================================
289304
# vim:tw=78:ts=8:ft=help:norl:

plugin/vim-todo-lists.vim

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,7 @@ function! VimTodoListsSetItemMode()
344344
inoremap <buffer> <S-Tab> <ESC>:VimTodoListsDecreaseIndent<CR>A
345345
endfunction
346346

347+
" Appends date at the end of the line
347348
function! VimTodoListsAppendDate()
348349
if(g:VimTodoListsDatesEnabled == 1)
349350
let l:date = strftime(g:VimTodoListsDatesFormat)

0 commit comments

Comments
 (0)