From af5ba43aa393c63981a71e97338baec434e77a83 Mon Sep 17 00:00:00 2001 From: Tim Pope Date: Sat, 24 Jul 2021 07:23:36 -0400 Subject: [PATCH] Reference plugin file as canonical API documentation --- autoload/fugitive.vim | 3 +++ doc/fugitive.txt | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/autoload/fugitive.vim b/autoload/fugitive.vim index af324be..ced9338 100644 --- a/autoload/fugitive.vim +++ b/autoload/fugitive.vim @@ -1,6 +1,9 @@ " Location: autoload/fugitive.vim " Maintainer: Tim Pope +" 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 diff --git a/doc/fugitive.txt b/doc/fugitive.txt index ca647e8..232e84f 100644 --- a/doc/fugitive.txt +++ b/doc/fugitive.txt @@ -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