Skip to content

Commit aefcf3d

Browse files
authored
Doc improvements (#226)
* doc: move license, add header line Move the license to the bottom, adding an additional help tag for it, so that when the help page is initially opened, one can directly read the table of content. While at it, also add a short description to the first line of the help page, so that it gets correctly displayed at :h local-additions. Signed-off-by: Christian Brabandt <cb@256bit.org> * Disable the colorcolumn when viewing the help file Signed-off-by: Christian Brabandt <cb@256bit.org> --------- Signed-off-by: Christian Brabandt <cb@256bit.org>
1 parent 1485657 commit aefcf3d

1 file changed

Lines changed: 33 additions & 28 deletions

File tree

doc/editorconfig.txt

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,10 @@
1-
*editorconfig.txt*
1+
*editorconfig.txt* EditorConfig plugin for vim.
22

33
File: editorconfig.txt
44
Version: 1.1.1
55
Maintainer: EditorConfig Team <http://editorconfig.org>
66
Description: EditorConfig vim plugin
77

8-
License:
9-
Copyright (c) 2011-2019 EditorConfig Team
10-
All rights reserved.
11-
12-
Redistribution and use in source and binary forms, with or without
13-
modification, are permitted provided that the following conditions are met:
14-
15-
1. Redistributions of source code must retain the above copyright notice,
16-
this list of conditions and the following disclaimer.
17-
2. Redistributions in binary form must reproduce the above copyright notice,
18-
this list of conditions and the following disclaimer in the documentation
19-
and/or other materials provided with the distribution.
20-
21-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24-
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25-
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26-
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27-
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28-
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29-
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30-
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31-
POSSIBILITY OF SUCH DAMAGE.
32-
33-
348
CONTENTS~
359
*editorconfig-contents*
3610
----------------------------------------------------------------------------
@@ -39,6 +13,7 @@ CONTENTS~
3913
3. Commands |editorconfig-commands|
4014
4. Settings |editorconfig-settings|
4115
5. Advanced |editorconfig-advanced|
16+
6. License |editorconfig-license|
4217

4318

4419
OVERVIEW~
@@ -230,4 +205,34 @@ And add the following code to your .editorconfig file:
230205
Then try to open an Objective-C file, you will find the |filetype| is set to
231206
"objc".
232207

233-
vim:ft=help:tw=78
208+
License~
209+
*editorconfig-license*
210+
----------------------------------------------------------------------------
211+
212+
License:
213+
Copyright (c) 2011-2019 EditorConfig Team
214+
All rights reserved.
215+
216+
Redistribution and use in source and binary forms, with or without
217+
modification, are permitted provided that the following conditions are met:
218+
219+
1. Redistributions of source code must retain the above copyright notice,
220+
this list of conditions and the following disclaimer.
221+
2. Redistributions in binary form must reproduce the above copyright notice,
222+
this list of conditions and the following disclaimer in the documentation
223+
and/or other materials provided with the distribution.
224+
225+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
226+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
227+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
228+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
229+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
230+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
231+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
232+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
233+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
234+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
235+
POSSIBILITY OF SUCH DAMAGE.
236+
237+
238+
vim:ft=help:tw=78:cc=

0 commit comments

Comments
 (0)