From 7f06c8c7b57bd1d5523a75bb8b302e91aa9f400f Mon Sep 17 00:00:00 2001 From: xylous Date: Sun, 30 Jan 2022 11:01:58 +0200 Subject: [PATCH] Add a boilerplate & fix vague comments --- gitstatus.plugin.zsh | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/gitstatus.plugin.zsh b/gitstatus.plugin.zsh index e9953f9..77f3a18 100755 --- a/gitstatus.plugin.zsh +++ b/gitstatus.plugin.zsh @@ -1,7 +1,15 @@ +# gitstatus zsh plugin +# https://github.com/xylous/gistatus +# +# Code licensed under the MIT License +# https://raw.githubusercontent.com/xylous/gitstatus/master/LICENSE +# +# @author xylous +# @maintainer xylous + ### -# Print the final gitstatus prompt to stdout -# Arguments: $1 -i, if it's an inline prompt => add a whitespace at the end, if -# not empty +# Print a formatted gitstatus prompt to stdout +# Options: -i add a whitespace at the end, if the output isn't empty ### function gitstatus() {