62ab5406dd89848bb26e8c6e648eb7d860e9dce5

Author
Lawrence Shah <lawrenceshah@users.noreply.github.com>
Committer
GitHub <noreply@github.com>
Date

Message

docs(custom): update comments in example files (#11727)

Diff

 1diff --git a/custom/example.zsh b/custom/example.zsh
 2index c505a96738a879c45d910d3e33e5d8d30077f0b8..21a8d8be7c861c94b6b37fc524793754ed1dd0b2 100644
 3--- a/custom/example.zsh
 4+++ b/custom/example.zsh
 5@@ -1,10 +1,12 @@
 6-# You can put files here to add functionality separated per file, which
 7-# will be ignored by git.
 8-# Files on the custom/ directory will be automatically loaded by the init
 9-# script, in alphabetical order.
10-
11-# For example: add yourself some shortcuts to projects you often work on.
12-#
13+# Put files in this folder to add your own custom functionality.
14+# See: https://github.com/ohmyzsh/ohmyzsh/wiki/Customization
15+# 
16+# Files in the custom/ directory will be:
17+# - loaded automatically by the init script, in alphabetical order
18+# - loaded last, after all built-ins in the lib/ directory, to override them
19+# - ignored by git by default
20+# 
21+# Example: add custom/shortcuts.zsh for shortcuts to your local projects
22+# 
23 # brainstormr=~/Projects/development/planetargon/brainstormr
24 # cd $brainstormr
25-#
26diff --git a/custom/plugins/example/example.plugin.zsh b/custom/plugins/example/example.plugin.zsh
27index 406f27445b76feced2ff33e2d09b079f6739eca3..83611fe3f1ace91ee279d28c50500fccf694cddb 100644
28--- a/custom/plugins/example/example.plugin.zsh
29+++ b/custom/plugins/example/example.plugin.zsh
30@@ -1,2 +1,3 @@
31 # Add your own custom plugins in the custom/plugins directory. Plugins placed
32 # here will override ones with the same name in the main plugins directory.
33+# See: https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-plugins
34diff --git a/custom/themes/example.zsh-theme b/custom/themes/example.zsh-theme
35index ef8f1c630b7c39783a3f65ff17678cfba81c932d..494d029e89f082d6846a368d23812428269dceeb 100644
36--- a/custom/themes/example.zsh-theme
37+++ b/custom/themes/example.zsh-theme
38@@ -1,4 +1,6 @@
39 # Put your custom themes in this folder.
40+# See: https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-themes
41+# 
42 # Example:
43 
44 PROMPT="%{$fg[red]%}%n%{$reset_color%}@%{$fg[blue]%}%m %{$fg[yellow]%}%~ %{$reset_color%}%% "