From cef45a3a17af01489df3ee668eaadde6bc29f662 Mon Sep 17 00:00:00 2001
From: Ibrahim Muftee <ibrahim@muftee.net>
Date: Thu, 16 May 2024 02:13:16 -0500
Subject: docs: create docstrings for most root level files

---
 .chezmoi.toml.tmpl                            | 4 ++--
 dot_config/nvim/lua/plugins/nvim-cmp.lua.tmpl | 1 +
 dot_gitconfig.tmpl                            | 4 ++--
 dot_zshrc.tmpl                                | 8 ++++++++
 run_powershell.bat.tmpl                       | 3 ++-
 5 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/.chezmoi.toml.tmpl b/.chezmoi.toml.tmpl
index 3b55171..fc66123 100644
--- a/.chezmoi.toml.tmpl
+++ b/.chezmoi.toml.tmpl
@@ -8,8 +8,8 @@
 # templateable values. The resulting file is then created at
 # `~/.config/chezmoi/chezmoi.toml`
 # See https://www.chezmoi.io/docs/how-to/
-#
-# {{/* This file supports Go's text/template language. */}}
+
+{{/* This file supports Go's text/template language. */ -}}
 
 {{ $git_email := promptStringOnce . "git_email" "Email address for Git global config" -}}
 {{ $git_name := promptStringOnce . "git_name" "Display name for Git global config" -}}
diff --git a/dot_config/nvim/lua/plugins/nvim-cmp.lua.tmpl b/dot_config/nvim/lua/plugins/nvim-cmp.lua.tmpl
index 60c77d3..d7b6661 100644
--- a/dot_config/nvim/lua/plugins/nvim-cmp.lua.tmpl
+++ b/dot_config/nvim/lua/plugins/nvim-cmp.lua.tmpl
@@ -14,6 +14,7 @@
 -- file and wrapping template directives in Lua comments. This has the
 -- side effect of adding a few extra random dash characters to the
 -- rendered file, but I don't mind.
+--
 -- */}}
 
 -- Optional features:
diff --git a/dot_gitconfig.tmpl b/dot_gitconfig.tmpl
index a8e6b81..fb97bed 100644
--- a/dot_gitconfig.tmpl
+++ b/dot_gitconfig.tmpl
@@ -6,8 +6,8 @@
 # I work with Git on Windows and Linux, and some configuations might
 # use different locations. This mainly contains the aliases I want
 # to keep consistent between machines.
-#
-# {{/* This file supports Go's text/template language. */}}
+
+{{/* This file supports Go's text/template language. */ -}}
 
 [push]
 	autoSetupRemote = true
diff --git a/dot_zshrc.tmpl b/dot_zshrc.tmpl
index a6288fe..368dd9c 100644
--- a/dot_zshrc.tmpl
+++ b/dot_zshrc.tmpl
@@ -1,5 +1,13 @@
 # vim:ft=zsh
 
+# ~/.zshrc
+# ============================================================================
+# This is my ZSH configuration. It uses the Starship prompt. There are
+# lots of things here I borrowed from other places. I need to decide
+# what features I use and what features I can get rid of.
+
+#{{- /* This file supports Go's text/template language. */ -}}
+
 # Enable colors and change prompt:
 autoload -U colors && colors    # Load colors
 # PS1="%B%{$fg[red]%}[%{$fg[yellow]%}%n%{$fg[green]%}@%{$fg[blue]%}%M %{$fg[magenta]%}%~%{$fg[red]%}]%{$reset_color%}$%b "
diff --git a/run_powershell.bat.tmpl b/run_powershell.bat.tmpl
index 78d97c3..c2f1e1b 100644
--- a/run_powershell.bat.tmpl
+++ b/run_powershell.bat.tmpl
@@ -1,5 +1,6 @@
 {{ if eq .chezmoi.os "windows" -}}
-:: -*-mode:bat-*- vim:ft=bat
+:: -*-mode:bat-*-
+:: vim:ft=bat
 
 :: ~/.local/share/chezmoi/run_powershell.bat
 :: ============================================================================
-- 
cgit v1.2.3