Skip to content

Commit 841953b

Browse files
authored
docs: Correct misleading comment about ZSH plugin loader behavior (#1201)
## Description Fixed a misleading inline comment in `Configs/.config/zsh/plugin.zsh` that incorrectly explained how to enable/disable the ZSH plugin loader. ### What was wrong The comment stated: "Comment this line to disable HyDE's plugin loader" But the actual behavior is the opposite: commenting the line enables the plugin loader. ### What was fixed - Changed comment to correctly state: "Comment this line to enable HyDE's plugin loader" - Removed confusing "same as HYDE_ZSH_NO_PLUGINS" reference for clarity - No functional code changes, only documentation correction ### Impact Prevents user confusion about how to properly enable/disable ZSH plugins in HyDE. ## Type of change - [x] **Documentation update** (non-breaking change; modified files are limited to the documentations) ## Checklist - [x] I have read the [CONTRIBUTING](https://github.com/HyDE-Project/HyDE/blob/master/CONTRIBUTING.md) document. - [x] My code follows the code style of this project. - [x] My commit message follows the [commit guidelines](https://github.com/HyDE-Project/HyDE/blob/master/COMMIT_MESSAGE_GUIDELINES.md). - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have added a changelog entry. - [x] I have added necessary comments/documentation to my code. - [ ] I have added tests to cover my changes. - [x] I have tested my code locally and it works as expected. - [ ] All new and existing tests passed. ## Additional context This is a simple documentation fix that corrects misleading information in an inline comment. The functional behavior remains unchanged.
2 parents 259f2cc + 8f93b4e commit 841953b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Configs/.config/zsh/plugin.zsh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Use your plugin system here
22

3-
return 1 # <--- Comment this line to disable HyDE's plugin loader // same as HYDE_ZSH_NO_PLUGINS
3+
return 1 # <--- Comment this line to disable HyDE's oh-my-zsh plugins and use the zinit examples below
44

55
#! This file will not load, remove the return 1 line above to enable this file.
66
#? Below is an example of how to set up Zsh plugins using Zinit

0 commit comments

Comments
 (0)