Reference plugin file as canonical API documentation

This commit is contained in:
Tim Pope
2021-07-24 07:23:36 -04:00
parent 8b0a40dfa2
commit af5ba43aa3
2 changed files with 7 additions and 0 deletions

View File

@@ -1,6 +1,9 @@
" Location: autoload/fugitive.vim
" Maintainer: Tim Pope <http://tpo.pe/>
" The functions contained within this file are for internal use only. For the
" official API, see the commented functions in plugin/fugitive.vim.
if exists('g:autoloaded_fugitive')
finish
endif

View File

@@ -601,6 +601,10 @@ a statusline, this one matches the default when 'ruler' is set:
>
set statusline=%<%f\ %h%m%r%{FugitiveStatusline()}%=%-14.(%l,%c%V%)\ %P
<
API *fugitive-api*
Officially supported functions are documented inline in plugin/fugitive.vim.
DEPRECATIONS *fugitive-deprecated*
The following commands are deprecated in favor of replacements that adhere to